Passer au contenu principal
Git est un système de gestion de versions qui vous permet de suivre les modifications apportées à votre documentation et de collaborer avec les membres de votre équipe. Avec Git, pour chaque fichier de votre projet, vous pouvez voir ce qui a changé, quand et pourquoi. Git facilite également le retour à des versions antérieures des fichiers si vous en avez besoin. L’Éditeur web effectue certaines opérations Git en arrière-plan. Comprendre ces concepts vous aidera à travailler plus efficacement avec l’Éditeur web et à collaborer avec les membres de l’équipe qui travaillent dans leurs environnements de développement locaux.

​
Concepts Git fondamentaux

La source de votre documentation où sont stockés tous les fichiers et leur historique. L’Éditeur web se connecte à votre dépôt pour accéder au contenu et le modifier.
Un instantané enregistré de vos modifications à un moment donné. Chaque commit inclut un message décrivant ce qui a changé et crée une trace permanente dans l’historique de votre projet.
Une branche pointe vers un commit précis dans votre dépôt. Votre documentation en ligne est générée à partir d’une branche de déploiement. Vous pouvez avoir autant d’autres branches contenant des modifications qui ne sont pas encore publiées sur votre documentation en ligne. Si vous souhaitez intégrer les modifications d’une branche à votre documentation en ligne, vous pouvez fusionner cette branche dans votre branche de déploiement via une pull request.Utilisez les branches pour travailler sur des modifications sans impacter votre documentation en ligne, expérimenter en toute sécurité de nouvelles fonctionnalités et obtenir des revues avant la publication.
La branche principale de votre projet à partir de laquelle est généré le contenu de votre documentation en ligne. Les modifications apportées à cette branche sont automatiquement publiées sur votre site de documentation. Souvent appelée main, mais vous pouvez définir n’importe quelle branche comme branche de déploiement.
Un moyen de proposer la fusion des modifications d’une branche dans votre documentation en ligne. Permet la revue et la discussion avant la mise en production des changements. Couramment appelée PR, et appelée merge request dans GitLab.
Un diff (ou « différence ») montre les changements entre deux versions d’un fichier. Lors de la revue des pull requests, les diffs mettent en évidence ce qui a été ajouté, supprimé ou modifié, ce qui facilite l’identification des changements.

​
Comment l’Éditeur web utilise Git

L’Éditeur web se connecte à votre dépôt Git via l’application GitHub ou l’intégration GitLab et automatise les opérations Git courantes. Lorsque vous :
  • Ouvrez un fichier : l’éditeur récupère la dernière version depuis votre dépôt pour vous assurer de toujours travailler avec un contenu à jour.
  • Apportez des modifications : l’éditeur suit vos modifications comme un brouillon pouvant devenir un commit lorsque vous êtes prêt à enregistrer votre travail.
  • Enregistrez des modifications : l’éditeur crée un commit avec vos changements, conservant votre travail dans l’historique du projet.
  • Créez une branche : l’éditeur crée une nouvelle branche dans votre dépôt, accessible à toute personne disposant des droits nécessaires pour collaborer et relire les changements.
  • Publiez sur votre branche de déploiement : l’éditeur effectue un commit puis pousse directement sur votre branche de déploiement, ce qui publie immédiatement vos modifications.
  • Publiez sur d’autres branches : l’éditeur crée une pull request, ce qui vous permet d’obtenir des retours avant de fusionner vos modifications dans votre branche de déploiement.

​
Bonnes pratiques Git

Chaque équipe élaborera ses propres workflows et préférences, mais voici quelques bonnes pratiques générales pour bien démarrer.
  • Rédigez des messages de commit descriptifs : soyez précis sur ce qui a changé et utilisez une formulation active.
  • Utilisez des noms de branche explicites : ils doivent décrire le travail réalisé et être parlants pour toute personne qui consulte les branches de votre dépôt.
  • Gardez les branches ciblées : limitez les changements d’une branche à une tâche ou un projet précis.
  • Supprimez les branches après fusion : supprimez-les lorsque vous n’en avez plus besoin afin de garder votre dépôt propre.