Hello tout le monde 
.
Je me suis rendu compte que la documentation de l’écosystème june est très dispersée sur les sites (ex: doc de duniter sur le site duniter, doc des pods cesium/gchange sur le site de benoit…)
Je me demandais si ça serait pas une bonne idée de créer une plateforme de documentation unifiée pour tout l’écosystème duniter, cela permettrait de retrouver les documentations plus facilement au lieu de devoir aller se balader sur tous les sites 
Si l’idée vous tente, je peux bricoler quelque chose avec docausaurus (un SSG open source développé par facebook qui est fait pour générer des sites de documentations)
Dites moi ce que vous en pensez.
Bonne soirée.
1 Like
C’est gentil, mais je serai plutôt d’avis de rajouter les liens vers les docs dans les sites officiels qui rassemblent déjà les infos. Je t’invite à ping @HugoTrentesaux ou @ManUtopiK si tu veux qu’ils rajoutent des liens sur les sites qu’ils maintiennent.
Afin de ne pas rajouter un site en plus …
3 Likes
D’autant qu’il y a des docs de natures différentes (manuels, FAQ, tutos, documentations d’API) qui ont parfois leurs plateformes adaptées (par exemple les bibliothèques Rust).
Quant aux instructions d’installation elles devraient être dans le dépôt du projet directement.
Edit: par contre s’il y a dispersion de la doc d’un projet, ça peut être intéressant de la regrouper, de préférence sur son site officiel ou dans son dépôt. Pas besoin d’une plateforme unique pour tous les projets, il y a déjà des annuaires pour trouver les projets, il manque juste les liens de ces projets vers leurs docs.
1 Like
Pour info, concernant la doc des Pod CS+ et gchange, elle sont générées a partir des markdown qui sont dans le repo git.
Donc en gros, le repo suffit …
La doc MD est ensuite générée en HTML par un plugin Apache Maven.
Mais je peux la déployer sur n’importe quel serveur, dès lors que j’ai un accès ssh dessus.
1 Like
Oui, sujet important. Ce que je préconise, c’est d’avoir la documentation dev et utilisateur dans le même dépôt que le code (en anglais), et de la télécharger la partie “utilisateur” au moment de la compilation du site statique. Ainsi le wiki duniter.org pourra réunir la documentation utilisateur de plusieurs logiciels dans un format standard.
J’avais fait un exemple pour la doc de Duniter 1.9 (https://duniter.fr/wiki/doc/duniter1.9doc/), mais évidemment tout est à refaire maintenant qu’on passe à l’écosystème v2 et que je maintiens la version anglophone du site. C’est comme ça que j’envisage la documentation pour la suite, mais la première étape est bien de l’écrire !!
Si tu as envie de contribuer à ça, j’avais ébauché un script python (https://git.duniter.org/websites/duniter_website_fr_v2/-/blob/master/scripts/get_external_content.py). Il faudrait l’améliorer notamment pour conserver les images et s’assurer que aucun lien hypertexte n’est cassé (par exemple un lien relatif interne au dépôt mais qui pointe vers une page non importée) et éventuellement ajouter une note pointant vers l’original.
@llaq d’ailleurs, si tu veux contribuer, pour l’instant je privilégie l’anglais. Première page mise en place :
Dernière version du script :