Contribuer à la documentation

La documentation est un site Nuxt. Son code source est sur GitLab. Chaque page est un fichier Markdown du dossier content/.

Vous pouvez contribuer de trois façons :

• Signalez un problème dans un ticket GitLab. Il faut un compte GitLab.
• Posez la question sur le forum.
• Proposez une modification dans une merge request.

Organisation des pages

Le numéro au début d'un nom de fichier ou de dossier fixe l'ordre dans le menu. Il n'apparaît pas dans l'adresse de la page. Par exemple, content/1.v5/3.dodock/15.contribuer/2.documentation.md est publiée à l'adresse /v5/dodock/contribuer/documentation.

Chaque page commence par un en-tête YAML avec un title et une description d'une phrase.

Modifier une page existante

1. En bas de la page, cliquez sur Proposer une correction. GitLab ouvre l'éditeur du fichier source de la page. Il faut être connecté à GitLab.
2. Faites votre modification.
3. Décrivez la modification et validez. Si vous n'êtes pas membre du projet, GitLab enregistre la modification dans votre copie du projet (fork).
4. Ouvrez la merge request vers la branche main du projet.

Si la fonction existe dans les deux versions, corrigez la page dans content/1.v5/ et dans content/2.next/.

Créer une nouvelle page

1. Cherchez d'abord une page existante sur le même sujet. Complétez-la si elle existe.
2. Créez le fichier dans un dossier existant, avec un numéro qui le place au bon endroit du menu.
3. Ajoutez l'en-tête :

   ---
   title: Titre de la page
   description: Une phrase qui dit ce que la page permet de faire.
   ---
   

4. Rangez les images dans public/images/, dans le dossier qui reprend l'adresse de la page sans la version.

Règles de rédaction

• Écrivez en français, avec « vous ».
• Commencez par le but de la tâche et ses prérequis.
• Écrivez les procédures en étapes numérotées, une action par étape.
• Reprenez les libellés exacts de l'interface.
• Décrivez le comportement actuel du logiciel, pas les fonctions à venir.

Prévisualiser en local

Il faut Node.js et Yarn.

yarn install
yarn dev

Le site est disponible à l'adresse http://localhost:3000. Avant d'envoyer une modification de structure, lancez node scripts/audit-nav.mjs. Le script doit afficher 0 problème.