Contribuer à la documentation

Ce guide explique comment ajouter une nouvelle page de documentation ou enrichir un dossier existant, dans le respect de notre workflow d’équipe.

Étape 1 : Créer une branche depuis master

sur le projet : https://gitlab.continuousnet.com/zenify-trip/documentation

1. Assure-toi d’être à jour avec master :

   git checkout master
   git pull origin master

2. Crée une nouvelle branche dédiée à ta contribution :

   git checkout -b docs/<oodo_ticket_name>

   📌 Format attendu : docs/<oodo_ticket_name>
   Exemple : docs/ZT-6789

Étape 2 : Ajouter ton fichier Markdown

1. Crée un fichier .md dans le dossier concerné (ex : docs/agility/ma-doc.md).

2. Commence ton fichier par un frontmatter comme celui-ci :

   id: nom-de-ta-doc
   title: Titre de la page
   sidebar_position: XX
   
   # Titre principal
   
   Le contenu de ta documentation ici.

3. Si tu veux créer un nouveau sous-dossier, Créer le dossier et son fichier de configuration :

   mkdir docs/.../nouveau-dossier
   touch docs/.../nouveau-dossier/_category.json

ajoute également un fichier _category_.json dans ce dossier :

Exemple :

     {
     "position": 1,
     "label": "deployment",
     "collapsible": true,
     "collapsed": true,
     "className": "red",
     "link": {
         "type": "generated-index",
         "title": "deployment"
         }
     }

Étape 3 : Commit avec message standard

1. Ajoute les fichiers modifiés :

   git add .

2. Effectue un commit avec un message respectant la convention Git :

        git commit -m "docs: add new page about [your topic]"

3. Réfère-toi à la page git-standards pour plus d’exemples si nécessaire.

Étape 4 : Push et création de Merge Request

1. Pousse ta branche :

   git push origin docs/<oodo_ticket_name>

2. Crée une Merge Request vers master sur GitLab ou GitHub.

Étape 5 : Revue et fusion

• La MR doit être relue par l’équipe.
• Seul Mohamed Ali Frad est autorisé à faire la fusion vers master.

⚠️ Tu ne dois jamais fusionner toi-même la MR.

Résumé rapide

Étape	Commande ou action
Nouvelle branche	git checkout -b docs/ZT-xxxx
Nouveau fichier	docs/categorie/ma-doc.md
Commit standard	git commit -m "docs: ajout de la page ..."
Push	git push origin docs/ZT-xxxx
MR	Ciblant master
Fusion finale	Par Mohamed Ali Frad

Besoin d’aide ?

Tu peux soumettre ta MR en mode Brouillon (Draft) si tu veux un retour ou une validation avant finalisation.

Tu peux aussi contacter Mohamed Ali directement pour un accompagnement personnalisé.