Skip to main content
Git vous permet de contrôler et de suivre les modifications apportées aux fichiers. Git est le système de contrôle de version de référence pour les workflows docs-as-code, où vous gérez la documentation comme n’importe quel autre code. L’éditeur en ligne gère les opérations Git à votre place. Comprendre quelques concepts clés vous aide à tirer le meilleur parti de l’éditeur et à collaborer avec votre équipe.

​
Ce que Git fait pour votre documentation

Git suit chaque modification apportée à votre documentation. Il enregistre ce qui a changé, qui l’a modifié, quand cela a été modifié et pourquoi. Cela vous permet de :
  • Voir l’historique complet de n’importe quelle page.
  • Annuler des modifications en revenant à une version précédente.
  • Travailler sur des mises à jour sans affecter votre site en ligne.
  • Examiner les modifications avant leur mise en ligne.
Votre référentiel de documentation est l’ensemble des fichiers, et de leur historique, qui composent votre site de documentation. L’éditeur web se connecte à ce référentiel pour lire et mettre à jour votre contenu.

​
Concepts clés

Voici les concepts Git que vous rencontrerez le plus souvent en utilisant l’éditeur web.
Une capture enregistrée de vos modifications à un moment précis. Chaque commit inclut un message décrivant ce qui a changé et crée un enregistrement permanent dans l’historique de votre projet.Lorsque vous enregistrez des modifications, l’éditeur web crée un commit.
Une ligne de développement distincte dans votre référentiel. Parfois appelée feature branch.Votre documentation en production est générée à partir d’une branche de déploiement, généralement appelée main. Les autres branches vous permettent de travailler sur des modifications de manière indépendante. Rien sur une branche n’affecte votre site en production avant que vous ne la fusionniez dans votre branche de déploiement au moyen d’une pull request (demande de fusion).Lorsque vous créez une branche, l’éditeur web crée une nouvelle branche dans votre référentiel. Vous pouvez passer d’une branche à l’autre depuis la liste déroulante des branches dans la barre d’outils.
La branche qui génère votre site de documentation en production, généralement appelée main. Les modifications fusionnées dans cette branche sont automatiquement déployées sur votre site.
Une proposition visant à fusionner des modifications d’une branche dans une autre. Les pull requests (demandes de fusion) permettent à votre équipe d’examiner et de discuter les changements avant leur mise en production.Lorsque vous publiez des modifications sur une feature branch, l’éditeur web crée une pull request. Votre équipe examine et fusionne la pull request dans votre fournisseur Git (GitHub ou GitLab).
L’action consistant à combiner les modifications d’une branche dans une autre. Une fois qu’une pull request a été examinée et approuvée par votre équipe, la fusion de la branche intègre vos modifications dans la branche de déploiement et les publie.
Se produit lorsque deux personnes modifient différemment la même partie d’un fichier. L’éditeur vous aide à résoudre tous les conflits qui surviennent sur vos branches.
Une comparaison qui montre les différences entre deux versions d’un fichier. Lors de l’examen des pull requests, les diffs mettent précisément en évidence ce qui a changé.

​
Correspondance entre l’éditeur et Git

Chaque action que vous réalisez dans l’éditeur en ligne correspond à une opération Git.
Votre action dans l’éditeurOpération Git en arrière-plan
Ouvrir un fichierRécupérer la dernière version à partir de votre référentiel
Enregistrer les modificationsCréer un commit, un instantané de vos modifications dans l’historique du projet
Créer une brancheCréer une branche, une ligne de travail distincte qui n’affecte pas votre site en production sauf si vous choisissez de la publier
Publier sur votre branche de déploiementPousser directement votre commit, ce qui déclenche un déploiement
Publier sur une branche de fonctionnalitéCréer une pull request (demande de fusion), une proposition pour fusionner vos modifications dans la branche de déploiement