mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
65c0d2ae25
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
103 lines
5.4 KiB
Plaintext
103 lines
5.4 KiB
Plaintext
---
|
||
title: "Collaborer dans l’éditeur web"
|
||
sidebarTitle: "Collaborer"
|
||
description: "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."
|
||
keywords: ["editor", "collaboration", "branches", "pull requests", "preview deployments", "share links"]
|
||
---
|
||
|
||
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](/fr/guides/git-concepts).
|
||
|
||
<div id="branch-based-collaboration">
|
||
## Collaboration basée sur des branches
|
||
</div>
|
||
|
||
Utilisez des branches pour travailler en parallèle sur les mises à jour de votre documentation sans affecter votre site en production.
|
||
|
||
<div id="why-use-branches">
|
||
### Pourquoi utiliser des branches
|
||
</div>
|
||
|
||
* **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.
|
||
|
||
<div id="recommended-workflow">
|
||
## Workflow recommandé
|
||
</div>
|
||
|
||
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.
|
||
|
||
<Steps>
|
||
<Step title="Créer une pull request">
|
||
Créez une pull request depuis l’éditeur lorsque vous êtes prêt à publier vos modifications. Consultez <a href="/fr/editor/publish">Publier des modifications dans l’éditeur web</a> pour plus d’informations sur l’utilisation des pull requests.
|
||
</Step>
|
||
|
||
<Step title="Examiner les pull requests">
|
||
Examinez les pull requests sur votre plateforme Git, comme GitHub ou GitLab.
|
||
</Step>
|
||
|
||
<Step title="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.
|
||
</Step>
|
||
|
||
<Step title="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.
|
||
</Step>
|
||
</Steps>
|
||
|
||
<div id="preview-deployments">
|
||
## Déploiements de prévisualisation
|
||
</div>
|
||
|
||
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.
|
||
|
||
<div id="access-preview-deployments">
|
||
### Accéder aux déploiements de prévisualisation
|
||
</div>
|
||
|
||
1. Cliquez sur **Share** dans la barre d’outils de l’éditeur.
|
||
2. Cliquez sur **Preview** pour ouvrir le déploiement de prévisualisation dans un nouvel onglet.
|
||
3. L’URL de prévisualisation affiche votre documentation avec toutes les modifications enregistrées.
|
||
|
||
<Frame>
|
||
<img src="/images/editor/share-preview-light.png" className="block dark:hidden" alt="Bouton Share dans la barre d’outils de l’éditeur" />
|
||
|
||
<img src="/images/editor/share-preview-dark.png" className="hidden dark:block" alt="Bouton Share dans la barre d’outils de l’éditeur" />
|
||
</Frame>
|
||
|
||
<div id="share-previews">
|
||
### Partager les prévisualisations
|
||
</div>
|
||
|
||
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.
|
||
|
||
<div id="preview-authentication">
|
||
### Authentification pour la prévisualisation
|
||
</div>
|
||
|
||
Les URL de prévisualisation sont accessibles publiquement par défaut. Activez l’authentification de prévisualisation sur la page [Modules complémentaires](https://dashboard.mintlify.com/products/addons) de votre dashboard pour restreindre l’accès aux membres authentifiés de l’organisation.
|
||
|
||
<div id="share-editor-links">
|
||
## Partager des liens de l’éditeur
|
||
</div>
|
||
|
||
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.
|
||
|
||
<Tip>
|
||
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.
|
||
</Tip>
|