Passer au contenu principal
Les branches sont une fonctionnalité de gestion de versions qui pointent vers des commits spécifiques dans votre dépôt. 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 essayer 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 affecter ce que les utilisateurs voient sur votre site en production jusqu’à ce que vous publiiez les changements. Nous recommandons de toujours travailler à partir de branches lors de la mise à jour de la documentation afin de garder votre site en production stable et de permettre des flux de relecture.
  • Donnez des noms explicites aux branches pour que vos coéquipiers comprennent sur quoi vous travaillez.
  • Supprimez les branches après la fusion afin de garder votre dépôt organisé.
  • Prévenez votre équipe lorsque vous travaillez sur des changements majeurs susceptibles d’affecter leur travail.

Création d’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. Saisissez un nom descriptif pour votre branche, par exemple update-getting-started ou fix-api-examples.
  4. Sélectionnez Create Branch.

Enregistrer des modifications sur une branche

Pour enregistrer vos modifications sur une branche, cliquez sur le bouton Save Changes dans l’angle 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. Dans le menu déroulant, choisissez la branche vers laquelle vous souhaitez basculer.
Les modifications non enregistrées seront perdues lors du changement de branche. Pensez à enregistrer ou publier votre travail avant de changer de branche.