mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
bb46980604
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
75 lines
5.5 KiB
Plaintext
75 lines
5.5 KiB
Plaintext
---
|
||
title: "Notions essentielles de Git pour l’éditeur en ligne"
|
||
sidebarTitle: "Notions essentielles de Git"
|
||
description: "Comprenez les concepts de contrôle de version Git qui sous-tendent l’éditeur web Mintlify, notamment les branches, les commits, les pull requests et les workflows de fusion."
|
||
keywords: ["git", "contrôle de version", "éditeur web", "branches", "commits", "pull requests", "PRs"]
|
||
---
|
||
|
||
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.
|
||
|
||
<div id="what-git-does-for-your-docs">
|
||
## Ce que Git fait pour votre documentation
|
||
</div>
|
||
|
||
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.
|
||
|
||
<div id="key-concepts">
|
||
## Concepts clés
|
||
</div>
|
||
|
||
Voici les concepts Git que vous rencontrerez le plus souvent en utilisant l’éditeur web.
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="Commit">
|
||
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.
|
||
</Accordion>
|
||
<Accordion title="Branche">
|
||
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 rechercher et basculer entre les branches depuis la liste déroulante des branches dans la barre d’outils. Si vous avez des modifications non enregistrées, l’éditeur vous permet de les transférer vers la nouvelle branche ou de les laisser sur votre branche actuelle.
|
||
</Accordion>
|
||
<Accordion title="Branche de déploiement">
|
||
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.
|
||
</Accordion>
|
||
<Accordion title="Pull request">
|
||
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).
|
||
</Accordion>
|
||
<Accordion title="Fusion">
|
||
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.
|
||
</Accordion>
|
||
<Accordion title="Conflit">
|
||
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.
|
||
</Accordion>
|
||
<Accordion title="Diff">
|
||
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é. L’éditeur web peut afficher les diffs de fichiers individuels lorsque vous examinez les modifications d’une branche avant de publier.
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
|
||
<div id="how-the-editor-maps-to-git">
|
||
## Correspondance entre l’éditeur et Git
|
||
</div>
|
||
|
||
Chaque action que vous réalisez dans l’éditeur en ligne correspond à une opération Git.
|
||
|
||
| Votre action dans l’éditeur | Opération Git en arrière-plan |
|
||
|---|---|
|
||
| Ouvrir un fichier | Récupérer la dernière version à partir de votre référentiel |
|
||
| Enregistrer les modifications | Créer un **commit**, un instantané de vos modifications dans l’historique du projet |
|
||
| Créer une branche | Cré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éploiement | Pousser 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 | |