main, représente le contenu utilisé pour construire votre documentation en production. Toutes les autres branches sont indépendantes de votre documentation publiée, 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 jusqu’à la publication des changements.
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
- Sélectionnez le nom de la branche dans la barre d’outils de l’éditeur (en général
mainpar défaut). - Sélectionnez Nouvelle branche.
- Entrez un nom descriptif pour votre branche, par exemple
update-getting-startedoufix-api-examples. - Sélectionnez Créer une branche.
Enregistrement des modifications sur une branche
Changer de 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.