0eb7e75421
Contribution now have to be made on the main branch. A new `documentation` branch is created. Github and Gitlab pipelines are now working on this branch. Develop branch is deprecated, as it is no more necessary.
2.9 KiB
+++ title="Documenter" description="Documenter le plugin, ou traduire la documentation." weight=50 chapter=false +++
Généralités
Toujours vous annoncer avant de commencer à travailler (en créant un ticket ou en commentant un ticket existant). Ceci afin d'éviter que plusieurs personnes travaillent sur la même chose et entrent en conflit.
Le travail de documentation se fait sur la branche main.
Le code source de la documentation se trouve dans le dossier
support/documentation/content du dépot de code.
La documentation est générée via l'outils Hugo. Celui-ci doit être installé sur votre machine pour pouvoir prévisualiser la documentation.
Le thème utilisé est hugo-theme-learn. Il est recommandé d'en lire la documentation avant de commencer.
Quand une version du plugin est publiée, ou quand la documentation est mise
à jour, les mainteneur⋅euses du plugin fusionnerons la branche main dans
la branche documentation, ce qui aura pour effet de déclencher les pipelines
github et gitlab pour mettre à jour les versions publiées.
Traductions
La langue principale est l'anglais (code en).
Les différentes traductions d'un même fichier sont côte-à-côte dans
l'arborescence, et sont identifiées par un code langue dans l'extension du
nom de fichier. Exemple: _index.fr.md est la tranduction française de
_index.en.md.
Attention, un fichier de traduction manquant n'apparaitra pas dans les menus du site générés. On veillera donc toujours à créer les fichiers pour toutes les langues, même si la traduction n'est pas encore disponible.
Pour cela, il y a un script doc-generate-missing-translations.sh à la racine
du dépot. Quand on ajoute un nouveau fichier, il suffit de créer la version
anglaise, puis de lancer ce script. Il va créer toutes les traductions
manquantes, on y mettant un message type invitant l'utilisateur⋅rice à lire la
version anglaise.
Ajout d'une nouvelle langue
Dans le fichier support/documentation/config.toml, inspirez vous de la
section [Languages.fr] pour déclarer la nouvelle langue.
Ensuite, lancez le script doc-generate-missing-translations.sh à la racine
du dépot. Celui-ci crééra tous les fichiers manquants pour la nouvelle langue.
Il ne vous reste plus qu'à les traduire. Si les traductions ne sont pas complètes, ce n'est pas grave, les fichiers générés afficherons un message proposant de changer de langue.
Prévisualiser
Pour prévisualiser vos modification, il suffit de lancer:
hugo serve -s support/documentation/
Puis d'ouvrir votre navigateur à l'adresse http://localhost:1313/peertube-plugin-livechat/. Cette page se raffraichira automatiquement à chaque modification.
Publication
La publication de la documentation est automatique, dès que les modifications
sont fusionnées dans la branche main.