Commit e91e70b4 authored by La Bécasse's avatar La Bécasse
Browse files

proposition de remise en forme de la documentation

parent 318002cd
......@@ -41,36 +41,6 @@ Oui. À partir du moment où des données sur les services des membres sont disp
## Fichiers _properties_
### Où trouver des modèles ?
Dans le dossier https://framagit.org/chatons/chatonsinfos/-/tree/master/MODELES :
* organization.properties : modèle pour un membre du collectif CHATONS ;
* services.properties : modèle générique pour un service ;
* services-foo.properties : modèle pour le service _foo_ (notamment les statistiques spécifiques).
### Où mettre les fichiers _properties_ ?
Les fichiers _properties_ doivent être accessibles publiquement sur le web. Du moment qu'un lien est disponible, c'est bon.
Par défaut, recommandation d'utiliser la convention des dossiers _.well_known_. Cela consiste à créer une arborescence _/.well_known/chatonsinfos/monfichier.properties_ sur un domaine web.
Quelques références :
* https://en.wikipedia.org/wiki/List_of_/.well-known/_services_offered_by_webservers
* https://tools.ietf.org/html/rfc8615
/i\ Si vous stockez ces fichiers sur Nextcloud, pensez à ajouter `download`à la fin de votre lien de partage.
### J'ai créé le fichier _properties_ de mon organisation, j'en fais quoi ?
D'abord, l'exposer sur le web pour avoir une URL diffusable. Ensuite, transmettre l'URL au collectif CHATONS par l'une des voies suivantes :
* courriel à contact@chatons.org
* merge-request sur le fichier https://framagit.org/chatons/chatonsinfos/-/blob/master/StatoolInfos/chatons.properties pour ajouter/modifier une ligne dans la section « [Subs] ».
### J'ai créé le fichier _properties_ d'un service, j'en fais quoi ?
D'abord l'exposer sur le web pour avoir une URL utilisable. Puis ajouter cette URL dans le fichier _properties_ de votre organisation, section « [Subs] ».
### Quelles contraintes pour les images ?
ChatonsInfos s'appuie sur des fichiers _properties_ pouvant contenir des liens vers des images (logo d'une organization, d'un service…).
......
......@@ -11,16 +11,49 @@ Maintenus en autonomie par les chatons volontaires, ces fichiers seront collect
* 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.
## DOCUMENTATION
### Fonctionnement général
## AUTEUR
ChatonsInfos s'appuie sur StatoolInfos qui utilise des fichiers publics disponibles via des liens web :
Le collectif CHATONS.
- 1 fichier web public pour décrire la fédération ;
- 1 fichier web public par organisation membre de la fédération ;
- 1 fichier web public par service des organisations.
## DOCUMENTATION
Chaque fichier web public étant acessible via un lien web, chaque fichier public peut se trouver sur un site web différent.
### Je suis un chaton, par où commencer ?
Il faut créer et mettre en ligne :
1. un fichier de propriétés *organisation* pour votre chaton en basant sur le modèle pour les [organisations](https://framagit.org/chatons/chatonsinfos/-/blob/master/MODELES/organization.properties),
2. un fichier de propriétés pour chaque *service* que vous proposez en utilisant [un des modèles service-*.properties](https://framagit.org/chatons/chatonsinfos/-/tree/master/MODELES) ou en se basant [sur ceux des autres chatons](https://stats.chatons.org/propertiesFiles.xhtml).
### Où mettre les fichiers properties ?
Tous les fichiers properties doivent être accessibles publiquement sur le web.
Par défaut, recommandation d'utiliser la convention des dossiers _.well_known_. Cela consiste à créer une arborescence _/.well_known/chatonsinfos/monfichier.properties_ sur un domaine web.
Quelques références :
* https://en.wikipedia.org/wiki/List_of_/.well-known/_services_offered_by_webservers
* https://tools.ietf.org/html/rfc8615
/i\ Si vous stockez ces fichiers sur Nextcloud, pensez à ajouter `download`à la fin de votre lien de partage.
### J'ai un lien pour le fichier properties de mon *organisation*, j'en fais quoi ?
Transmettre l'URL au collectif CHATONS par l'une des voies suivantes :
* courriel à contact@chatons.org
* merge-request sur le fichier https://framagit.org/chatons/chatonsinfos/-/blob/master/StatoolInfos/chatons.properties pour ajouter/modifier une ligne dans la section « [Subs] ».
### J'ai un lien pour le fichier properties d'un *service*, j'en fais quoi ?
Ajouter cette URL dans le fichier _properties_ de votre organisation, section « [Subs] ».
### Plan
Plan de la documentation :
* README.md : accueil ;
......@@ -32,6 +65,15 @@ Plan de la documentation :
* 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/.
## 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.
## LOGO
À propos du logo :
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment