Passer au contenu principal

​
Workflows de publication

L’éditeur prend en charge deux workflows pour publier des mises à jour de la documentation. Le workflow que vous utilisez dépend des règles de protection des branches de votre référentiel et de la branche sur laquelle vous travaillez. Si votre référentiel comporte des règles de protection des branches imposant une revue, l’éditeur crée une pull request (demande de fusion). Les membres de l’équipe peuvent examiner vos modifications avant qu’elles ne soient mises en ligne. Pour les workflows de collaboration et les processus de revue d’équipe, voir Collaborate. S’il n’y a aucune règle de protection, vos modifications sont fusionnées dans la branche de déploiement et déployées immédiatement.
Type de brancheProtection de la brancheCe qui se passe lorsque vous publiez
AucuneEffectue des commits et déploie les modifications
Branche de déploiementPull requests requisesCrée une pull request (demande de fusion)
AucuneFusionne les modifications dans la branche de déploiement et déploie
Branche de fonctionnalitéPull requests requisesCrée une pull request (demande de fusion)
Configurez des règles de protection des branches dans votre fournisseur Git pour exiger des pull requests. Voir À propos des branches protégées dans la documentation GitHub ou Branches protégées dans la documentation GitLab.

​
Enregistrer les modifications

Pendant que vous modifiez le contenu, l’éditeur suit vos changements.
  • Nouveaux fichiers ou fichiers supprimés.
  • Modifications de contenu dans les pages.
  • Changements dans la structure de navigation.
  • Téléversement et organisation des médias.
  • Mises à jour de la configuration.
Barre d’outils de l’éditeur web affichant une modification en attente.
Lorsque vous travaillez sur votre branche de déploiement, les modifications sont enregistrées automatiquement. Lorsque vous travaillez sur une branche de fonctionnalité, vous pouvez enregistrer les modifications dans la branche sous forme de .
Barre d’outils de l’éditeur web affichant une modification en attente et le bouton Save as commit sur une branche de fonctionnalité.
Pour annuler des modifications, cliquez sur Annuler les modifications à côté d’un nom de fichier dans le menu déroulant Changes.

​
Publier vos modifications

Si vous êtes sur votre branche de déploiement, cliquez sur Publish dans la barre d’outils. Selon votre flux de travail, vos modifications seront mises en ligne dès que votre site sera redéployé, ou bien créez une pull request (demande de fusion) et fusionnez-la dans votre fournisseur Git. Si vous êtes sur une branche de fonctionnalité, enregistrez vos modifications puis cliquez sur Publish dans la barre d’outils. Selon votre flux de travail, vos modifications seront mises en ligne dès que votre site sera redéployé, ou bien créez une pull request (demande de fusion) et fusionnez-la dans votre fournisseur Git.

​
Résoudre les conflits

Les conflits se produisent lorsque votre branche et la branche de déploiement comportent des modifications incompatibles dans les mêmes fichiers.

​
Quelles sont les causes des conflits ?

Les conflits surviennent lorsque :
  • Vous et un autre membre de l’équipe modifiez les mêmes lignes dans un fichier.
  • Des fichiers sont déplacés ou supprimés dans une branche, mais modifiés dans une autre.

​
Résoudre les conflits

L’éditeur affiche des avertissements lorsque des conflits empêchent d’effectuer des opérations comme la publication ou le changement de branche. Pour résoudre les conflits, suivez les instructions dans l’éditeur pour choisir les modifications à conserver.

​
Signature des commits

Signez vos commits avec votre compte GitHub en l’autorisant dans vos paramètres de compte. Sans cette autorisation, la GitHub App de Mintlify signe les commits effectués dans l’éditeur web. Attribuer les commits à votre compte permet de conserver un historique précis des personnes ayant modifié votre documentation.