Mise en place de l'environnement documentaire

Contexte et objectifs

En entrant en BTS SIO, j'ai dû construire un système de suivi de compétences opérationnel dès le départ. L'objectif était de disposer d'un outil pérenne, versionné et accessible en ligne pour documenter l'ensemble de mes travaux sur deux ans.

Documentation Git CI/CD HTML / CSS MkDocs GitLab Pages
Besoins identifiés
  • Structurer et mettre en forme les pages avec un langage web standard
  • Conserver un historique complet des modifications (versioning)
  • Accéder aux documents en ligne depuis n'importe quel poste
  • Organiser les fichiers de manière structurée et claire
  • Utiliser uniquement des outils gratuits et professionnels
  • Garantir la pérennité des données sur toute la durée de la formation

Solution technique retenue

Chaîne d'outils mise en place

J'ai mis en place une chaîne DevOps complète, composée des outils suivants :

  • VSCode : éditeur de texte principal
  • HTML / CSS : langages utilisés pour structurer et mettre en forme les pages
  • Git : gestion de versions et suivi des modifications
  • GitLab : hébergement du dépôt et déploiement via CI/CD
  • GitLab Pages : publication automatique du site
  • MkDocs : génération du site web à partir des fichiers sources
HTML / CSS — Pérennité

Le choix de l'HTML et du CSS garantit que la documentation reste exploitable sur le long terme, quel que soit l'environnement de travail.

  • Standard du web : l'HTML est le langage universel des navigateurs, aucun logiciel propriétaire n'est requis pour le lire
  • Format ouvert : lisible avec n'importe quel éditeur de texte, sur tous les systèmes d'exploitation
  • Interopérabilité : compatible avec tous les navigateurs, convertible en PDF sans perte
  • Apprentissage professionnel : maîtriser l'HTML est une compétence directement valorisable en entreprise
GitLab — Disponibilité

L'utilisation d'une forge comme GitLab assure la continuité du travail même en cas de panne ou de perte matérielle.

  • Sauvegarde automatique : chaque git push copie le travail sur des serveurs sécurisés
  • Reprise rapide : un simple git clone suffit pour tout récupérer sur un nouveau poste
  • Historique complet : retour en arrière possible à n'importe quelle version antérieure
CI/CD — Automatisation

Le pipeline CI/CD gère automatiquement la mise en ligne du portfolio à chaque modification validée.

  • Zéro manipulation manuelle : un simple git push déclenche la publication
  • Fiabilité : processus standardisé, sans risque d'erreur humaine
  • Gain de temps : le site est toujours le reflet exact du travail actuel

Note : la mise à jour n'est pas instantanée — GitLab doit construire la page (1 à 2 minutes). Penser à vider le cache du navigateur pour voir les changements.

Réalisation — Étapes
  1. Installation et configuration de VSCode avec les extensions nécessaires
  2. Apprentissage et mise en pratique de l'HTML et du CSS
  3. Création du dépôt Git et structuration des dossiers
  4. Configuration du fichier mkdocs.yml pour la navigation
  5. Mise en place du pipeline CI/CD vers GitLab Pages
  6. Activation du versioning pour conserver l'historique
  7. Publication et synchronisation du dépôt en ligne

Preuves de réalisation

Capture du site en ligne
Site en ligne
Historique Git (Git Graph)
Git Graph
Configuration MkDocs
Configuration MkDocs
Pipeline GitLab CI/CD
Pipeline CI/CD
Preuve du git push réussi

Terminal affichant le chemin du projet et le message de succès du git push, avec Git Graph ouvert sur le dernier commit validé.

Preuve git push réussi