📚 Mise en place documentaire avec Git

1️⃣ Contexte et Objectifs

Dans le cadre du développement du portfolio et de la documentation technique du projet, il était nécessaire de mettre en place un système permettant de gérer les versions des fichiers et de suivre les modifications.

Lors d’un projet informatique, plusieurs fichiers évoluent régulièrement : documentation, code, configuration ou ressources du projet. Sans système de gestion de versions, il devient difficile de suivre les changements et de garantir la traçabilité du travail réalisé.

Pour répondre à ces besoins, l’outil Git a été utilisé. Git est un système de gestion de versions distribué largement utilisé dans le développement logiciel.

Le projet a également été publié sur une plateforme distante (GitLab) afin de sauvegarder le travail et faciliter l’accès aux différentes versions du projet.

Les objectifs de cette mise en place étaient :

  • mettre en place un dépôt Git
  • versionner la documentation et les fichiers du projet
  • centraliser les ressources
  • publier le projet sur une plateforme distante
  • assurer la sauvegarde et la traçabilité des modifications

2️⃣ Besoins identifiés

Plusieurs besoins ont été identifiés pour assurer une bonne gestion du projet :

  • suivre les modifications des fichiers
  • conserver un historique des versions
  • centraliser la documentation
  • sécuriser les données du projet
  • permettre une publication en ligne du projet

Sans système de gestion de versions, les modifications peuvent être difficiles à suivre et les erreurs peuvent entraîner la perte de données.

Il est donc nécessaire d’utiliser un outil de versionning fiable et adapté aux projets informatiques.

3️⃣ Solution technique retenue et justifications

Pour répondre aux besoins identifiés, la solution Git a été retenue.

Git est un système de gestion de versions distribué permettant de :

  • suivre les modifications d’un projet
  • conserver un historique complet
  • travailler sur différentes versions du code
  • synchroniser un projet avec un serveur distant

Utilisation du Markdown

La documentation du projet est rédigée en Markdown.

Pérennité

Le Markdown est un format simple, lisible et universel.

Il est composé uniquement de texte brut, ce qui présente plusieurs avantages :

  • lisible sans logiciel spécifique
  • facile à modifier
  • compatible avec de nombreux outils

Le Markdown est largement utilisé pour :

  • la documentation technique
  • les projets open source
  • les plateformes de développement

Il fonctionne parfaitement avec Git et facilite la gestion des versions.

Disponibilité

L’utilisation d’une forge logicielle comme GitLab permet d’assurer la disponibilité du projet.

Les avantages sont :

  • sauvegarde du projet en ligne
  • accès aux fichiers depuis n’importe quel poste
  • historique des modifications
  • traçabilité des mises à jour

Grâce aux push réguliers, les différentes versions du projet sont conservées et peuvent être récupérées à tout moment.

Automatisation et CI/CD

GitLab permet également d’intégrer des mécanismes d’automatisation.

Grâce au CI/CD (Continuous Integration / Continuous Deployment) :

  • les modifications peuvent être testées automatiquement
  • le site peut être déployé automatiquement
  • la mise à jour du projet est simplifiée

Cette automatisation améliore la fiabilité du projet et accélère les mises à jour.

4️⃣ Réalisation

Installation de Git

Sous Linux :

sudo apt update
sudo apt install git

Suite au parametrage de mon git on peut ensuite remplir le portfolio

La mise en place du dépôt Git s’est déroulée en plusieurs étapes.

Voici une capture de mon code pour le fichier mkdocs.yml :

Navigation

La page d'accueil se présente comme ceci avec un menu sur la gauche

Menu