Passer au contenu principal
Vos modifications sont enregistrées automatiquement pendant que vous travaillez, mais elles n’atteignent votre site publié que lorsque vous les publiez. Ce qui se passe lorsque vous publiez dépend de la branch sur laquelle vous travaillez et du fait que cette branch soit protégée ou non.
Publish n’apparaît que lorsqu’une page du site est ouverte. Les pages privées affichent Share à la place et ne sont jamais publiées. Les viewers ne voient pas Publish. S’il n’y a pas de bouton Publish sur une page du site, la publication automatique est activée sur votre projet et vos modifications sont mises en ligne automatiquement.S’il n’y a pas de sélecteur de branch, affichez le sélecteur de branch.Si vous ne voyez que vos propres modifications dans le menu Publish, activez Show teammates’ changes pour voir les modifications de tout le monde.Si Request review apparaît à la place de Publish sur votre deployment branch, votre projet exige une relecture avant publication.

​
Modifications en attente

Sur votre deployment branch, l’éditeur considère les éléments suivants comme des modifications en attente jusqu’à ce que vous les publiiez :
  • Les modifications de contenu dans les pages
  • Les pages ajoutées ou supprimées
  • Les changements de structure de navigation
  • Les médias téléversés
  • Les mises à jour de configuration
Cliquez sur Publish dans la barre d’outils pour voir vos modifications en attente. Cliquez sur n’importe quel fichier modifié pour le comparer à la version publiée.

​
Ce qui se passe lorsque vous publiez

  • Publish : Commit vos modifications en attente sur votre deployment branch et les déploie sur votre site publié.
  • Request review : Sur une feature branch, ouvre une pull request pour la branch, ou marque sa pull request en brouillon comme prête à être relue. Si votre projet exige une relecture avant publication, demande plutôt à vos collègues d’approuver vos modifications dans l’éditeur.
  • Merge and publish : Fusionne la pull request dans votre deployment branch et la déploie. Disponible dès que la pull request est prête ou approuvée, selon les exigences de relecture de votre dépôt. Si votre projet exige une relecture avant publication, l’éditeur affiche plutôt Publish approved changes une fois que les relecteurs ont approuvé toutes les pages.
  • Create branch : Crée une nouvelle feature branch lorsque vous ne pouvez pas publier sur la branch actuelle.
Une seule publication peut avoir lieu à la fois par branch. Si un collègue publie déjà sur la même branch, votre publication est mise en file d’attente et démarre automatiquement une fois la sienne terminée.
Votre site est mis à jour une fois que Mintlify a compilé et déployé vos modifications. Cela prend généralement de 30 secondes à quelques minutes. Le menu Publish affiche la progression pendant que vos modifications sont commitées, compilées et déployées, puis fournit un lien vers la page en ligne. Si la compilation échoue, cliquez sur View build log.

​
Un MDX non valide bloque la publication

Si une page de votre branch comporte un MDX non valide, l’éditeur désactive les boutons Publish et Request review jusqu’à ce que vous le corrigiez. Survolez Publish pour voir combien de pages ont des erreurs, puis ouvrez chaque page en mode source pour repérer et corriger l’erreur. Consultez Bouton Publish désactivé à cause d’un MDX non valide pour plus de détails.

​
Publier des modifications spécifiques

Lorsque plusieurs personnes ont des modifications en attente sur votre deployment branch, le paramètre Show teammates’ changes contrôle quelles modifications le menu Publish liste. Show teammates’ changes désactivé (par défaut) : Le menu Publish ne liste que vos modifications, sous Your changes. Cela comprend les fichiers que vous avez modifiés, les fichiers modifiés à la fois par vous et vos collègues, ainsi que les fichiers sans auteur enregistré. Les autres modifications en attente de vos collègues n’apparaissent pas dans le menu. Chacune de vos modifications dispose d’une case à cocher, et toutes sont sélectionnées par défaut. Décochez les modifications que vous voulez exclure, puis cliquez sur Publish. Seules les modifications sélectionnées sont publiées. Si vous décochez toutes les cases, l’éditeur désactive Publish. Show teammates’ changes activé : Le menu Publish répartit les modifications en attente entre Your changes et Modified by others. Vos modifications sont sélectionnées par défaut, tandis que celles des autres ne le sont pas. Utilisez les cases à cocher pour sélectionner les modifications à publier. Chaque section dispose de son propre bouton Discard, qui ne s’applique qu’aux modifications de cette section. Une icône de contributeurs marque les fichiers modifiés par une autre personne que vous. Survolez-la pour voir qui a modifié le fichier.
  • La sélection des modifications à publier ne s’applique que sur une deployment branch sans protections de branch. Sur les feature branches, la publication inclut toutes les modifications en attente.
  • Si votre deployment branch exige une relecture et que votre rôle ne peut pas publier sans relecture, le menu Publish n’affiche que vos propres modifications.
  • Supprimer un dossier supprime toutes les pages qu’il contient. Ces suppressions sont publiées ensemble. Vous ne pouvez pas supprimer partiellement un dossier.
  • Certaines modifications dépendent les unes des autres, comme une page et son entrée de navigation. Si votre sélection omet une modification dont dépend une modification sélectionnée, la publication échoue avec une erreur. Ajustez votre sélection pour inclure la dépendance, puis publiez à nouveau.

​
Travailler sur une branch

Modifiez directement sur votre deployment branch si vous n’utilisez pas de workflow de révision. Créez une branch si chaque modification passe par une révision avant d’atteindre votre site publié. Pour créer une branch :
  1. Cliquez sur le nom de la branch dans la barre d’outils de l’éditeur. Sur votre deployment branch, le nom comporte un badge Live.
  2. Vous pouvez saisir un titre pour votre branch dans Find a branch.
  3. Cliquez sur New branch.
Si vous ne saisissez pas de titre, l’éditeur nomme la branch d’après la date actuelle. Si vous avez des modifications en attente au moment où vous créez une branch, l’éditeur vous demande si vous voulez Bring them to this branch ou Leave them behind. Votre branch d’origine conserve ses modifications en attente dans les deux cas. Les modifications effectuées sur une branch que vous avez créée dans l’éditeur, ou sur une branch ayant une pull request ouverte, sont commitées automatiquement sur la branch, environ 15 secondes après que vous arrêtez d’écrire. Le premier commit ouvre une pull request vers votre deployment branch. La pull request s’ouvre en brouillon si Create draft pull requests by default est activé. Lorsque vos modifications sont prêtes, cliquez sur Publish, puis sur Request review. Une fois que votre pull request répond aux exigences de relecture de votre dépôt, cliquez sur Merge and publish. L’éditeur fusionne la pull request et vous ramène sur votre deployment branch.

​
Gérer les branches

Le menu des branches liste votre deployment branch, les branches que vous avez créées dans l’éditeur et les branches ayant une pull request ouverte ou en brouillon, y compris les pull requests ouvertes en dehors de l’éditeur. Chaque branch affiche l’état de sa pull request. Si votre projet exige une relecture avant publication et que vous ne pouvez pas publier sans relecture, le menu des branches n’affiche pas l’état ni les liens des pull requests. Pour trouver une branch fusionnée ou fermée, ou toute autre branch de votre dépôt, recherchez-la par son nom. Pour lister toutes les branches sans effectuer de recherche, activez Afficher toutes les branches dans les paramètres de l’éditeur. Pour renommer ou supprimer une branch, survolez-la dans le menu des branches et cliquez sur Rename branch ou Delete branch, puis confirmez. Renommer modifie le titre affiché dans l’éditeur et le titre de la pull request. Le nom de la branch Git reste le même. Supprimer une branch ferme sa pull request et retire définitivement la branch de votre dépôt, ainsi que toutes les modifications non publiées qu’elle contient. Les viewers ne peuvent pas renommer ni supprimer de branches.

​
Sous-branches

Si votre dépôt est hébergé sur GitHub, GitLab ou Azure Repos, vous pouvez travailler sur une sous-branch : une branch dont la branch parente est une branch autre que votre deployment branch, comme une feature branch pour une mise à jour importante. Une branch devient une sous-branch lorsque vous la créez dans l’éditeur alors que vous êtes sur une autre branch que la deployment branch, ou lorsque sa pull request cible une branch autre que la deployment branch. Le menu des branches liste les sous-branches ayant une pull request ouverte ou en brouillon, y compris les pull requests ouvertes en dehors de l’éditeur. Les pull requests des sous-branches que vous créez dans l’éditeur ciblent votre deployment branch par défaut. Tant que la pull request d’une sous-branch est ouverte, le menu de publication affiche deux boutons à la place de Publish ou Merge and publish :
  • Publish to <deployment branch> : Fusionne la sous-branch dans votre deployment branch et la déploie.
  • Merge into <parent branch> : Fusionne la sous-branch dans sa branch parente. Votre site en ligne ne change pas tant que la branch parente n’est pas fusionnée dans votre deployment branch.
Si vous cliquez sur le bouton d’une branch que la pull request ne cible pas encore, l’éditeur modifie d’abord la branch cible de la pull request chez votre fournisseur Git, puis la fusionne. Si la cible ne peut pas être modifiée, l’éditeur affiche une erreur et n’effectue pas la fusion. Après la fusion, l’éditeur vous place sur la branch dans laquelle vous avez fusionné. La liste des modifications de la branch dans le menu de publication compare votre sous-branch à la branch cible actuelle de sa pull request.

​
Afficher le sélecteur de branch

Si votre deployment branch n’a pas de protections de branch, l’éditeur masque le sélecteur de branch lorsque vous travaillez sur la deployment branch. Pour l’afficher, ouvrez une page du site, cliquez sur More options dans la barre supérieure, puis activez Branches. Cette préférence ne s’applique qu’à vous. Le sélecteur de branch apparaît toujours lorsque votre deployment branch a des protections de branch ou lorsque vous travaillez sur une feature branch.

​
Résoudre les conflits

Lorsque quelqu’un pousse des modifications vers votre dépôt en dehors de l’éditeur, l’éditeur fusionne ses modifications dans les pages que vous avez ouvertes. Une notification vous indique combien de mises à jour ont été appliquées. Si une modification distante et la vôtre portent sur la même partie d’une page, l’éditeur conserve les deux versions et les met en évidence. Passez en revue le contenu mis en évidence, conservez la version que vous souhaitez et supprimez l’autre.

​
Signature des commits

Signez vos commits avec votre compte GitHub en l’autorisant dans la section Integrations de vos paramètres de Profil. Sans cette autorisation, la GitHub App de Mintlify signe les commits effectués dans l’éditeur.

​
Publication automatique

Si la publication automatique est activée sur votre projet, l’éditeur commit sur votre deployment branch environ une minute après que vous arrêtez de modifier. Le sélecteur de branch et le bouton Publish sont masqués. Il n’y a ni état en attente ni étape de révision. La publication automatique et Require review before publishing ne peuvent pas être activées en même temps. Si un admin active l’une, l’autre se désactive.