Passer au contenu principal
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.
  1. Créez une branche dédiée à votre fonctionnalité pour vos modifications.
  2. Effectuez et enregistrez vos modifications sur cette branche.
  3. Créez une pull request (demande de fusion) lorsque vous êtes prêt pour la revue.
  4. Traitez les commentaires et mettez à jour la branche.
  5. Fusionnez la pull request (demande de fusion) une fois qu’elle a été approuvée.
Ce workflow permet de s’assurer que les modifications sont revues avant leur mise en production et qu’un historique clair des mises à jour est conservé.

​
Workflow des pull requests (demandes de fusion)

Les pull requests (demandes de fusion) vous permettent de proposer des modifications et de collaborer avec votre équipe avant de les fusionner dans votre documentation en production.
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. Ils seront automatiquement envoyés vers la pull request existante.
4

Fusionner les pull requests

Fusionnez votre pull request lorsque toutes les modifications demandées ont été prises en compte, que la pull request a été approuvée par les relecteurs requis 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 vos modifications avant leur mise en ligne.
1

Accéder aux déploiements de prévisualisation

  • Cliquez sur Share dans la barre d’outils de l’éditeur.
  • Cliquez sur Preview pour ouvrir le déploiement de prévisualisation dans un nouvel onglet.
  • L’URL de prévisualisation affiche votre documentation avec toutes les modifications enregistrées appliquées.
2

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.
3

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.