Wiki GitLab - Documenter vos Projets Techniques

Les Pages Wiki sur GitLab : Centraliser votre documentation logicielle

La mémoire de votre projet

Le code source n'est que la partie émergée de l'iceberg. Pour qu'un projet vive longtemps et soit compréhensible par tous, il a besoin d'une documentation solide. Le Wiki de GitLab est l'outil parfait pour cela : il permet de créer une véritable encyclopédie interne pour votre dépôt.

Contrairement au fichier README.md qui reste souvent technique et limité à un seul fichier, le Wiki permet de structurer des dizaines de pages (guides d'installation, règles de contribution, architecture logicielle). C'est un espace collaboratif où chaque membre de l'équipe peut apporter sa pierre à l'édifice.

Rôle utilisateur	Action sur le Wiki
Guest (Invité)	Lecture seule des pages
Reporter	Lecture seule des pages
Developer / Maintainer	Création et édition autorisées

Créer une page Wiki pas à pas

Pas besoin de maîtriser des outils complexes : si vous savez écrire du texte, vous savez documenter votre projet sur GitLab.

Accéder à l'espace Wiki

Depuis votre projet, repérez et cliquez sur l'onglet Plan puis Wiki dans le menu latéral. Si c'est votre première visite, GitLab vous proposera de créer votre première page Wiki.

"L'onglet Wiki est situé juste à côté de Plan"

Rédaction et mise en forme

Remplissez les informations de votre nouvelle page :

Title : Donnez un nom clair à votre page (ex : "Guide d'installation"). C'est le titre qui apparaîtra en haut de votre documentation logicielle.
Path : GitLab génère automatiquement l'adresse URL à partir du titre. Vous pouvez décocher la case Generate page path from title si vous souhaitez personnaliser manuellement le lien d'accès.
Format : Par défaut, le Markdown est sélectionné. C'est le langage standard pour mettre en forme vos textes (gras, titres, listes) très simplement.
Template : Une nouveauté majeure qui permet de choisir un modèle de page pré-rempli pour gagner du temps et garder une structure cohérente sur tout le Wiki de GitLab.
Content : C'est votre zone de travail. Vous pouvez utiliser l'éditeur visuel ou cliquer sur Switch to plain text editing pour rédiger directement en code Markdown.
Commit message : Comme pour une modification de code, rédigez une courte phrase expliquant l'ajout ou la modification de la page (ex : "Création de la documentation réseau").

Cliquez sur le bouton bleu Create page pour enregistrer votre travail.

Consultation du résultat

Votre page est désormais en ligne. Vous pouvez voir l'historique des modifications, ce qui est très pratique pour savoir qui a mis à jour la documentation et quand.

"Votre documentation est maintenant accessible à toute l'équipe"

Information technique

Techniquement, le Wiki est un dépôt Git séparé. Cela signifie que les utilisateurs avancés peuvent même cloner le Wiki sur leur ordinateur pour rédiger la documentation hors-ligne et la pousser comme s'il s'agissait de code classique.

Conclusion

Utiliser les Pages Wiki transforme votre dépôt en un projet professionnel et pérenne. Une bonne documentation réduit drastiquement le temps d'apprentissage des nouveaux arrivants et évite les erreurs dues au manque d'informations.

Maintenant que votre projet est complet (code, tickets, jalons et documentation), il ne faut pas oublier l'essentiel : la sécurité de vos données. Dans le prochain chapitre, nous allons apprendre à créer une sauvegarde GitLab (Backup) pour ne jamais rien perdre.

Chapitre précédent