Les branches sont une fonctionnalité de gestion de versions qui pointent vers des commits spécifiques dans votre référentiel. Votre branche de déploiement, généralement appelée main, représente le contenu utilisé pour générer votre documentation en production. Toutes les autres branches sont indépendantes de votre documentation en ligne, sauf si vous choisissez de les fusionner dans votre branche de déploiement.
Les branches vous permettent de créer des instances distinctes de votre documentation pour apporter des modifications, obtenir des relectures et tester de nouvelles approches avant la publication. Votre équipe peut travailler sur des branches pour mettre à jour différentes parties de la documentation en parallèle, sans modifier ce que les utilisateurs voient sur votre site en ligne tant que vous n’avez pas publié les changements.
Nous recommandons de toujours travailler à partir de branches lors de la mise à jour de la documentation afin de garder votre site en ligne stable et de permettre des workflows de relecture.
- Donnez des noms explicites aux branches pour que vos coéquipiers comprennent sur quoi vous travaillez.
- Supprimez les branches après fusion pour garder votre référentiel organisé.
- Prévenez votre équipe lorsque vous travaillez sur des changements majeurs susceptibles d’affecter leur travail.
- Sélectionnez le nom de la branche dans la barre d’outils de l’éditeur (en général
main par défaut).
- Sélectionnez Nouvelle branche.
- Entrez un nom descriptif pour votre branche, par exemple
update-getting-started ou fix-api-examples.
- Sélectionnez Créer une branche.
Enregistrement des modifications sur une branche
- Sélectionnez le nom de la branche dans la barre d’outils de l’éditeur.
- Choisissez la branche vers laquelle vous souhaitez passer dans le menu déroulant.
Les modifications non enregistrées seront perdues lors du changement de branche. Assurez-vous d’enregistrer ou de publier votre travail avant de changer de branche.
