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 précédentes des fichiers si vous en avez besoin. L’éditeur web exécute certaines opérations Git en arrière-plan. Comprendre ces concepts vous aidera à travailler plus efficacement avec l’éditeur web et à collaborer avec des membres de l’équipe qui travaillent dans leur environnement de développement local.

​
Concepts Git essentiels

La source de votre documentation, où tous les fichiers et leur historique sont stockés. L’éditeur web se connecte à votre référentiel pour accéder au contenu et le modifier.
Une capture instantanée enregistrée de vos modifications à un moment précis. 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 spécifique dans votre référentiel. Votre documentation en production 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 (demande de fusion).Utilisez des 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 relectures avant publication.
La branche principale de votre projet à partir de laquelle le contenu de votre documentation en ligne est généré. Les modifications apportées à cette branche sont automatiquement publiées sur votre site de documentation. Souvent nommée main, mais vous pouvez définir n’importe quelle branche comme branche de déploiement.
Un moyen de proposer la fusion de vos modifications d’une branche dans votre documentation en ligne. Permet la relecture et la discussion avant la mise en ligne des changements. Couramment appelée PR, et aussi appelée merge request dans GitLab.
Un diff (ou différence) montre les changements entre deux versions d’un fichier. Lors de la relecture 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 référentiel Git via la GitHub App 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 référentiel, pour vous garantir de toujours travailler avec un contenu à jour.
  • Apportez des modifications : l’éditeur suit vos modifications comme un brouillon qui pourra devenir un commit lorsque vous serez prêt à enregistrer votre travail.
  • Enregistrez les modifications : l’éditeur crée un commit avec vos modifications, préservant votre travail dans l’historique du projet.
  • Créez une branche : l’éditeur crée une nouvelle branche dans votre référentiel, utilisable par toute personne ayant accès au référentiel afin de collaborer et de relire les modifications.
  • Publiez sur votre branche de déploiement : l’éditeur effectue un commit et 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 (demande de fusion), ce qui vous permet d’obtenir des retours d’autres personnes 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é en utilisant une tournure active.
  • Utilisez des noms de branche explicites : Les noms de branche doivent décrire le travail effectué et être parlants pour quelqu’un qui consulte les branches de votre référentiel.
  • Limitez la portée des branches : Concentrez les modifications d’une branche sur une tâche ou un projet spécifique.
  • Supprimez les branches après fusion : Supprimez les branches lorsque vous n’en avez plus besoin afin de garder votre référentiel propre.
⌘I