Contribuer au wiki

Le wiki est un site statique Hugo avec le thème Doks. Chaque page est un fichier Markdown dans content/docs/.

Où placer une page#

Chaque dossier contient un _index.md qui présente la section et liste ses pages. Pensez à y ajouter un lien vers la nouvelle page.

Créer une page#

Créez un fichier nom-de-la-page.md en minuscules, sans accents, avec des tirets, puis commencez par ce front matter :

---
title: "Titre de la page"
description: "Une ou deux phrases qui résument la page (utilisées par la recherche et les moteurs)."
slug: "nom-de-la-page"
draft: false
tags: ["apala"]
weight: 10
toc: true
---

• weight fixe l’ordre dans le menu : plus petit, plus haut.
• draft: true masque la page tant qu’elle n’est pas prête.
• tags : réutilisez des tags existants (voir la page des tags).

Conventions d’écriture#

• Écrire en français, sans jargon inexpliqué ; ajouter les termes techniques au glossaire.
• Un seul titre de niveau 1 (le title) ; commencer le texte par des titres ##.
• Liens internes absolus : [Texte](/docs/a-propos/presentation/), avec la barre finale.
• Liens externes : vérifier qu’ils fonctionnent et décrire la cible dans le texte du lien (pas « cliquez ici »).
• Citer la source de tout chiffre.
• Ne pas publier de données personnelles sans accord de la personne.

Tester en local#

npm install
npm run dev

Le site s’ouvre sur http://localhost:1313. Le projet comprend un contrôle des liens : lancez-le avant de proposer vos changements.

Relecture et publication#

1. Créer une branche et commiter vos changements.
2. Ouvrir une demande de fusion (merge request sur GitLab).
3. Faire relire par un autre membre de l’équipe.
4. Fusionner dans main.

Signaler une erreur#

Écrivez via le formulaire de contact en indiquant l’adresse de la page concernée.