Mise en place de l'environnement documentaire
1. Contexte et Objectifs
Dans le cadre de mon entrée en BTS SIO, j'ai dû mettre en place un outil de suivi de mes compétences. L'objectif était de disposer d'un système pérenne, versionné et accessible en ligne pour documenter mes travaux durant 2 ans.
2. Besoins identifiés
- Pouvoir rédiger rapidement (Langage léger).
- Disposer d'un historique des modifications (versioning).
- Pouvoir héberger les documents en ligne et y accéder depuis n'importe quel poste.
- Organiser les documents de manière structurée et claire.
- Utiliser des outils gratuits et adaptés à un usage professionnel.
- Garantir la pérennité des données sur la durée de la formation.
3. Solution technique
J'ai mis en place une chaîne "DevOps" composée des outils suivants :
- VSCode : Éditeur de texte principal.
- Markdown : Langage de balisage léger permettant une rédaction rapide et lisible.
- Git : Outil de gestion de versions pour suivre les modifications des documents.
- GitHub : Plateforme d'hébergement des dépôts Git, permettant l'accès en ligne et la sauvegarde du travail.
- GitLab : Outil d’hébergement de dépôts Git utilisé pour stocker les documents, gérer les versions et assurer l’accessibilité en ligne.
Pourquoi le Markdown ? (Pérennité)
J'ai choisi le Markdown pour garantir que ma documentation reste exploitable sur le long terme :
Format non propriétaire : Contrairement au .docx (Word), le Markdown est du texte brut. Il ne dépend d'aucun logiciel spécifique ou d'une licence payante. Cela garantit que mes documents seront toujours lisibles dans 10 ans avec n'importe quel éditeur de texte.
Universalité et Interopérabilité : C'est un standard utilisé par tous les outils de développement (VS Code, GitLab, GitHub). Le fichier peut être converti facilement en PDF ou en HTML sans perte de données, ce qui assure sa compatibilité avec les futurs outils.
Légèreté du stockage : Comme c'est du texte simple, les fichiers sont très légers et faciles à versionner avec Git, ce qui évite les risques de fichiers corrompus que l'on retrouve parfois sur des formats plus complexes.
Pourquoi GitLab ? (Disponibilité)
L'utilisation d'une Forge (GitLab) est ma sécurité contre les pannes :
Sauvegarde automatique : Dès que je fais un git push, mon travail est copié sur des serveurs sécurisés. Si mon PC tombe en panne ou est volé, je ne perds rien.
Reprise rapide : Comme je l'ai montré en Phase 1, il me suffit d'un git clone pour récupérer tout mon environnement de travail sur un nouveau poste en quelques secondes.
Historique : Si je fais une erreur ou que j'efface un fichier par accident, GitLab me permet de revenir en arrière sur mes anciennes versions.
Pourquoi le CI/CD ? (Automatisation)
Le CI/CD permet de gérer automatiquement la mise en ligne de mon portfolio :
Plus d'erreurs manuelles : Je n'ai plus besoin de transférer mes fichiers à la main (pas de FTP). Un simple push et GitLab s'occupe de mettre mon site à jour tout seul.
Gain de temps : Le système vérifie que tout est correct et publie la version la plus récente. Cela garantit que ma documentation en ligne est toujours le reflet exact de mon travail actuel.
Note sur le délai : La mise à jour n'est pas instantanée car GitLab doit "construire" la page (le pipeline). Il faut donc attendre 1 ou 2 minutes et vider le cache de son navigateur pour voir les changements.
4. Réalisation
- Installation et configuration de l'IDE VSCode avec les extensions nécessaires.
- Apprentissage de la syntaxe Markdown.
- Création d'un dépôt Git pour centraliser les fichiers de suivi de compétences.
- Mise en place d'un pipeline CI/CD pour le déploiement automatique vers GitLab Pages.
- Configuration du fichier mkdocs.yml pour structurer la navigation.
- Mise en place du versioning afin de conserver l'historique des modifications.
- Organisation des documents en dossiers (situations professionnelles, compétences, projets).
- Publication et synchronisation du dépôt sur GitHub pour un accès en ligne sécurisé.
5. Preuves de réalisation
Capture de mon site
Historique Git (Git Graph)
Configuration de MkDocs
Pipeline GitLab
Preuve de la mise en œuvre du workflow Git en mode nomade.
