Demandes de changement

Collaborez sur les modifications de contenu via des demandes de changement

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

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

Pour gérer les demandes de modification ouvertes dans toute votre organisation, consultez la écran des demandes de modification.

Modifiez votre contenu via des demandes de modification.

Examiner les modifications dans la vue diff

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

Par défaut, les modifications sont affichées en « vue fractionnée ». La partie gauche affiche la version « avant » de la page, et la partie droite l’état « après ». Si vous préférez afficher les modifications en ligne dans une mise en page à une seule colonne, cliquez sur le bouton du mode diff en haut à droite du panneau de la table des matières.

Créer et fusionner une demande de modification

1

Ouvrir une demande de modification

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

• Cliquez sur Modifier dans le coin supérieur droit d’un espace.
• Demandez à GitBook Agent d’en créer une pour vous.
• GitBook Agent 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 modification et l’ouvre dans l’éditeur.

2

Apportez vos modifications

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

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

3

Demander une relecture

Ouvrez l’ Aperçu onglet, puis identifiez 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 des autorisations de relecteur dans l’espace sont averties. Si l’espace n’a aucun relecteur, ce sont les éditeurs et les administrateurs qui sont avertis à la place.

Si quelqu’un demande des modifications, mettez à jour la demande de modification avant de la fusionner. Vous pouvez aussi demander à GitBook Agent d’examiner la demande de modification.

4

Fusionner

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

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

La fusion ne peut pas être annulée. Pour rétablir ou ajuster le contenu, ouvrez une nouvelle demande de modification.

Travailler avec les demandes de modification

Écran des demandes de modification

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

Demandes de modification dans un espace

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