thomas
/
StatsChatons
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
StatsChatons/README.md

74 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

rajout du readme
2021-05-12 22:39:41 +02:00
# ChatonsInfos
ajout instructions mise en ligne
2021-05-19 16:20:07 +02:00
## Utilisation
s/merlin/loth/g
2023-12-06 23:15:45 +01:00
À chaque mise à jour, aller sur loth, dans /srv/hadoly/wordpress/.well-known/statschatons et faire un git pull afin de récupérer la dernière version
ajout instructions mise en ligne
2021-05-19 16:20:07 +02:00
En cas de changement de l'url d'appel (https://www.hadoly.fr/.well-known/chatonsinfos/hadoly.properties) il faut prévenir le collectif
instructions de déploiement et mise à jour
2021-06-03 08:39:34 +02:00
## Mise à jour d'un service
En cas de changement de version d'un service, il convient de mettre à jour la fiche adéquate.
La version est stockée dans la clé _software.version_
Une fois les modifications comitées, faire un git pull depuis merlin (voir ci-dessous)
rajout du readme
2021-05-12 22:39:41 +02:00
## Comment contribuer
il suffit de relire les fichiers properties existants (hadoly.properties et service-XX.properties) ou de rajouter un service manquant.
Pour rajouter un service: il suffit de copier depuis le dossier MODELES le fichier service...properties correspondant au service à décrire (si ça se trouve il en existe déjà un).
Il suffit ensuite de l'éditer et de le compléter, en s'attardant sur les éléments marqués comme "obligatoire" et "recommandé"
instructions de déploiement et mise à jour
2021-06-03 08:39:34 +02:00
il faut ensuite déployer les fichiers sur merlin : Aller dans le répertoire _/var/www/StatsChatons/_ et faire un git pull
rajout du readme
2021-05-12 22:39:41 +02:00
instructions de déploiement et mise à jour
2021-06-03 08:39:34 +02:00
```bash
# sur merlin
s/merlin/loth/g
2023-12-06 23:15:45 +01:00
cd /srv/hadoly/wordpress/.well-known/statschatons
instructions de déploiement et mise à jour
2021-06-03 08:39:34 +02:00
sudo git pull
```
rajout du readme
2021-05-12 22:39:41 +02:00
## WTF ?
**ChatonsInfos** est un protocole de partage de données sur le collectif, ses membres et leurs services.
L’idée est de faire ça de façon simple et légère via des fichiers de description accessibles par lien web : 1 fichier par chaton et 1 fichier par service.
Maintenus en autonomie par les chatons volontaires, ces fichiers seront collectés régulièrement et valorisés dans le futur site https://stats.chatons.org/.
En favorisant un partage d’information sur les chatons et leurs services, les résultats attendus sont :
* une meilleure visibilité des chatons et de leurs services ;
* une mesure de l’activité des services : même incomplète ou partielle, cela donnera idée de l’activité globale.
## LICENCE
Sauf mention contraire, les documents du projet ChatonsInfos sont diffusés sous la licence libre Creative Commons CC-BY-SA.
## AUTEUR
Le collectif CHATONS.
## DOCUMENTATION
Plan de la documentation :
* README.md : accueil ;
* CONCEPTS.md : les concepts fondamentaux ;
* FAQ.md : une foire aux questions ;
* MODELES/federation.properties : modèle de fihcier _properties_ pour le collectif CHATONS ;
* MODELES/organization.properties : modèle de fichier _properties_ pour un membre du collectif CHATONS ;
* MODELES/services.properties : modèle de fichier _properties_ générique pour un service logiciel d'un membre du collectif CHATONS ;
* MODELES/services-xxxxx.properties : modèle de fichier _properties_ d'un logiciel précis, utile pour les métriques spécifiques.
* StatoolInfos/ : dossier de configuration de l'outil StatoolInfos, le générateur des pages de https://stats.chatons.org/.
## LOGO
À propos du logo :
* fichier : logo_ChatonsInfos.jpg ;
* source : projet StatoolInfos ;
* auteur: Christian Pierre MOMON christian.momon@devinsy.fr
* licence: Creative Commons CC-BY-SA last version.