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

3.0 KiB
Raw Blame History

ChatonsInfos

Utilisation

À chaque mise à jour, aller sur merlin, dans /var/www/StatsChatons et faire un git pull afin de récupérer la dernière version

En cas de changement de l'url d'appel (https://www.hadoly.fr/.well-known/chatonsinfos/hadoly.properties) il faut prévenir le collectif

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)

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é"

il faut ensuite déployer les fichiers sur merlin : Aller dans le répertoire /var/www/StatsChatons/ et faire un git pull

# sur merlin
cd /var/www/StatsChatons/
sudo git pull

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/.

À 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.