Demandes de modification

Collaborez sur les modifications de contenu via des demandes de modification

Une demande de changement est une copie de votre contenu principal. Elle repose sur le concept de branchement et sera familière à toute personne qui utilise des pull requests sur GitHub ou des merge requests sur GitLab.

Dans une demande de changement, vous pouvez modifier, mettre à jour et supprimer du contenu, demander des revues de vos changements, puis les fusionner à nouveau dans votre version principale.

Pour parcourir et gérer les demandes de changement ouvertes sur l’ensemble de votre site, consultez la écran des demandes de changement.

Modifiez votre contenu via des demandes de changement.

Examiner les changements dans la vue des différences

Ouvrez l’ Modifications onglet pour examiner les modifications d'une demande de changement. Vous pouvez consulter toutes les pages dans leur contexte, ou vous concentrer uniquement sur les pages modifiées.

En bas de l’éditeur, le navigateur de différences flottant vous permet de passer d’un bloc modifié à l’autre, de continuer vers la page suivante comportant des différences, et de terminer la revue à partir de la dernière modification grâce aux actions de revue disponibles.

Par défaut, les changements s’affichent en « vue scindée ». À gauche se trouve la version « avant » de la page, et à droite l’état « après ». Si vous préférez voir les changements en ligne dans une mise en page à une seule colonne, cliquez sur le bouton du mode de différences en haut à droite du panneau Table des matières.

Créer et fusionner une demande de changement

1

Ouvrir une demande de changement

Pour modifier du contenu, ouvrez une demande de changement. Vous pouvez en ouvrir une de plusieurs façons :

• Cliquez sur Modifier dans le coin supérieur droit d’une section.
• Demandez à l’Agent GitBook d’en créer une pour vous.
• L’Agent GitBook peut en créer une automatiquement lorsqu’il détecte une lacune dans la documentation.

Si vous en ouvrez une manuellement, GitBook crée la demande de changement et l’ouvre dans l’éditeur.

2

Apportez vos modifications

Modifiez directement le contenu dans l’éditeur, ou travaillez avec l’Agent GitBook.

Relisez vos modifications avant de passer à l’étape suivante. Vous pouvez continuer à modifier jusqu’à ce que vous soyez prêt à demander une revue.

3

Demander une revue

Ouvrez l’ Aperçu onglet, puis mentionnez un ou plusieurs relecteurs.

Les relecteurs peuvent approuver vos modifications, laisser des commentaires ou demander d’autres modifications. Si vous ne mentionnez personne, toutes les personnes disposant d’autorisations de relecture dans la section sont averties. Si la section n’a pas de relecteurs, ce sont les éditeurs et les administrateurs qui sont avertis à la place.

Si quelqu’un demande des modifications, mettez à jour la demande de changement avant de la fusionner. Vous pouvez également demander à l’Agent GitBook de l’examiner.

4

Fusionner

Une fois la demande de changement approuvée, ouvrez l’ Aperçu onglet et cliquez sur Fusionner.

GitBook applique immédiatement les modifications à votre documentation en ligne. Si votre section utilise des règles de fusion, GitBook les vérifie avant de fusionner.

La fusion est irréversible. Pour annuler ou ajuster le contenu, ouvrez une nouvelle demande de changement.

Travailler avec les demandes de changement

Écran des demandes de changement

Consultez et gérez les demandes de changement dans l’ensemble de votre organisation

Demandes de changement dans un espace

Créez et examinez des demandes de changement dans un seul espace