Travailler avec des branches

Utilisez des branches pour apporter et passer en revue des modifications sans affecter votre documentation en production

Les branches sont une fonctionnalité du contrôle de version 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 effectuer des changements, 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 votre documentation en parallèle, sans impacter ce que les utilisateurs voient sur votre site en ligne tant que vous ne publiez pas les modifications.

Nous recommandons de toujours travailler à partir de branches lors de la mise à jour de la documentation afin de garder votre site stable et de permettre des workflows de relecture.

• Donnez des noms explicites aux branches afin que vos coéquipiers comprennent sur quoi vous travaillez.
• Supprimez les branches après fusion pour garder votre référentiel organisé.
• Informez votre équipe lorsque vous travaillez sur des changements majeurs susceptibles d’affecter leur travail.

​

Créer une branche

1. Sélectionnez le nom de la branche dans la barre d’outils de l’éditeur (généralement main par défaut).
2. Sélectionnez New Branch.
3. Entrez un nom descriptif pour votre branche, comme update-getting-started ou fix-api-examples.
4. Sélectionnez Create Branch.

​

Enregistrer les modifications sur une branche

Pour enregistrer vos modifications sur une branche, sélectionnez le bouton Enregistrer les modifications dans le coin supérieur droit de l’éditeur. Cela crée un commit et pousse votre travail sur votre branche.

​

Changer de branche

1. Sélectionnez le nom de la branche dans la barre d’outils de l’éditeur.
2. Sélectionnez la branche à 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.