Collaborer dans l’éditeur web

Travaillez à plusieurs sur la documentation avec des branches, des pull requests (demandes de fusion), des déploiements de prévisualisation et des liens partageables vers l’éditeur.

Collaborez avec votre équipe sur la documentation en utilisant des workflows basés sur des branches, des pull requests (demandes de fusion) et des déploiements de prévisualisation.

Si vous ne connaissez pas Git, consultez Notions Git.

​

Collaboration basée sur des branches

Utilisez des branches pour travailler en parallèle sur les mises à jour de votre documentation sans affecter votre site en production.

​

Pourquoi utiliser des branches

• Isoler les modifications : Travaillez sur des mises à jour sans affecter votre documentation en ligne.
• Relire avant la publication : Obtenez des retours de la part des membres de l’équipe avant que les modifications ne soient mises en ligne.
• Travail en parallèle : Plusieurs membres de l’équipe peuvent travailler sur différentes branches simultanément.

​

Workflow recommandé

Utilisez des pull requests (demandes de fusion) pour proposer des modifications et collaborer avec votre équipe avant de les fusionner dans votre documentation en production. Ce workflow garantit que votre équipe relit les modifications avant la publication et conserve un historique clair des mises à jour.

1. Créer une pull request

   Créez une pull request depuis l’éditeur lorsque vous êtes prêt à publier vos modifications. Consultez Publier des modifications dans l’éditeur web pour plus d’informations sur l’utilisation des pull requests.

2. Examiner les pull requests

   Examinez les pull requests sur votre plateforme Git, comme GitHub ou GitLab.

3. Répondre aux commentaires

   Lorsque les relecteurs demandent des modifications, appliquez les changements demandés et enregistrez vos modifications. Les modifications supplémentaires sont automatiquement envoyées vers la pull request existante.

4. Fusionner les pull requests

   Fusionnez votre pull request après avoir pris en compte toutes les modifications demandées, que les relecteurs requis ont approuvé la pull request, et que toutes les vérifications automatisées ont réussi.

​

Déploiements de prévisualisation

Les déploiements de prévisualisation créent des URL temporaires où vous pouvez voir le rendu de vos modifications avant leur mise en ligne. Utilisez les déploiements de prévisualisation pour recueillir des retours sur le rendu de ces modifications.

Chaque fois que vous cliquez sur « Enregistrer les modifications » sur une branche, le déploiement de prévisualisation se met à jour automatiquement.

​

Accéder aux déploiements de prévisualisation

1. Cliquez sur Publish dans la barre d’outils de l’éditeur.
2. Cliquez sur l’URL de prévisualisation pour ouvrir le déploiement de prévisualisation dans un nouvel onglet. Le format de l’URL est organization-branch-name.mintlify.app.

​

Partager les prévisualisations

Partagez l’URL du déploiement de prévisualisation avec les membres de l’équipe pour recueillir leurs retours. Les prévisualisations se mettent automatiquement à jour lorsque vous enregistrez des modifications supplémentaires.

​

Authentification pour la prévisualisation

Les URL de prévisualisation sont accessibles publiquement par défaut. Activez l’authentification de prévisualisation sur la page Modules complémentaires de votre dashboard pour restreindre l’accès aux membres authentifiés de l’organisation.

​

Partager des liens de l’éditeur

Partagez un lien direct vers une page spécifique dans l’éditeur avec vos collègues. Utilisez les liens de l’éditeur pour collaborer sur des mises à jour et apporter des modifications aux pages.

Lorsque vous ouvrez une page, l’éditeur enregistre le chemin d’accès dans l’URL. Copiez l’URL depuis la barre d’adresse de votre navigateur pour la partager avec les collègues qui ont accès à l’éditeur.

Le format de l’URL est : https://dashboard.mintlify.com/{org}/{project}/editor/{branch}?file={filepath}

Par exemple, https://dashboard.mintlify.com/acme/docs/editor/main?file=guides/quickstart.mdx ouvre le fichier quickstart.mdx sur la branche main.

Toute personne ayant accès à votre organisation Mintlify peut utiliser le lien pour ouvrir le fichier directement dans l’éditeur.

Lorsque vous partagez une page, indiquez à vos destinataires sur quelle branche vous travaillez afin qu’ils puissent s’assurer qu’ils consultent la bonne version.