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 provient du concept simple 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 modification, vous pouvez modifier, mettre à jour et supprimer des éléments de votre contenu, demander des relectures sur vos modifications, puis les fusionner dans votre version principale pour appliquer tous les changements que vous avez effectués.
Création d'une demande de modification
Dans un espace où les modifications en direct sont désactivées, cliquez sur le Modifier bouton dans le en-tête de l'espace pour démarrer une nouvelle demande de modification.
Cela ouvrira une nouvelle demande de modification, où vous pourrez modifier ou supprimer du contenu selon vos besoins. Vos modifications sont enregistrées automatiquement, et d'autres personnes peuvent vous rejoindre dans une demande de modification pour collaborer en temps réel.
Une fois que vous êtes satisfait de vos modifications, vous pouvez utiliser le bouton dans la barre d'en-tête pour Demander une relecture de votre demande de modification, ou Fusionner la directement dans la branche principale.
Aperçu d'une demande de modification
Vous pouvez prévisualiser les modifications que vous avez apportées dans une demande de modification via le bouton d'aperçu dans le en-tête de l'espace. Cela vous basculera vers une vue avec vos documents et les modifications proposées dans une fenêtre d'aperçu, afin que vous puissiez voir vos changements dans le contexte complet de votre documentation publiée.
Si votre contenu est publié en utilisant des liens de partage ou un accès authentifié, la fonction d'aperçu n'apparaîtra pas.
Demander une relecture d'une demande de modification
Demandez une relecture de votre demande de modification lorsque vous souhaitez demander aux membres de votre équipe de vérifier votre contenu avant de fusionner les modifications dans la branche principale.
Vous pouvez ajouter une description à votre demande de modification pour donner du contexte à vos relecteurs, et taguer des personnes spécifiques que vous souhaitez voir vérifier votre travail.
Lorsque vous cliquez sur Demander une relecture, le statut de la demande de modification passera à En cours de relecture, et toute personne que vous avez taguée dans votre demande de relecture recevra une notification.
Si vos modifications ne nécessitent pas de relecture, vous pouvez fusionner vos modifications directement dans la version principale à la place.
Relecture d'une demande de modification
Si vous recevez une demande de relecture d'une demande de modification, vous pourrez modifier le contenu et laisser des commentaires pour vous assurer qu'il est en bon état avant qu'il ne soit fusionné dans la version principale. Vous pouvez soit demander des modifications si vous pensez qu'il doit encore être travaillé, soit approuver la demande de modification, pour indiquer qu'elle est prête à être fusionnée.
La plupart des relectures auront lieu dans les commentaires, où les collaborateurs peuvent partager des retours et avoir des discussions sur des blocs de contenu spécifiques, ou sur la demande de modification dans son ensemble.
Vue des différences
Lorsque vous ouvrez l'onglet Modifications dans l'en-tête de l'espace, la vue des différences apparaîtra. La vue des différences met en évidence chaque page et bloc qui a été modifié dans une demande de modification. Elle mettra en évidence toutes les pages modifiées dans la table des matières, et sur les pages elle montrera les blocs spécifiques qui ont été ajoutés, modifiés ou supprimés.
Il y a deux options lors de l'utilisation de la vue des différences :
Afficher toutes les pages – Il s'agit du mode par défaut pour la vue des différences, qui affichera à la fois les pages modifiées et non modifiées dans la table des matières. C'est utile pour voir quelles pages ont été modifiées dans le contexte de l'ensemble de l'espace.
Afficher uniquement les pages modifiées – Ce mode n'affichera que les pages modifiées dans la table des matières, ce qui vous aide à vous concentrer sur le contenu modifié. Ceci est particulièrement utile dans les grands espaces avec de nombreuses pages et sous-pages.
Vous pouvez basculer vers l'onglet Modifications pour vérifier la vue des différences dans n'importe quelle demande de modification.
Fusion d'une demande de modification
La fusion d'une demande de modification ajoutera les changements de la demande dans la branche principale du contenu, créant une version mise à jour et une nouvelle entrée dans l'historique des versions.
Planification des fusions
Si vous préférez fusionner les demandes de modification à un moment planifié — par exemple, pour vous aligner sur vos cycles de sortie produit — vous pouvez utiliser des outils externes comme GitHub Actions ou des plateformes d'automatisation telles que Zapier, connectés via l'API de GitBook.
À titre d'exemple, ajouter ce workflow GitHub fusionnerait une demande de modification une fois par semaine :
name: Fusion GitBook planifiée
on:
schedule:
- cron: '0 9 * * 3' # S'exécute tous les mercredis à 09:00 UTC
jobs:
merge_changes:
runs-on: ubuntu-latest
steps:
- name: Merge Change Request
run: |
curl -X POST https://api.gitbook.com/v1/spaces/{space-id}/change-requests/{change-request-id}/merge \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json'Gestion des conflits de fusion
Parfois, lorsque vous souhaitez fusionner une demande de modification, vous pouvez découvrir des conflits entre le contenu principal et le contenu que vous essayez de fusionner. Dans sa forme la plus simple, un conflit est un élément de contenu qui n'a pas pu être fusionné automatiquement.
Si cela se produit, une alerte de conflit vous sera présentée, ainsi qu'une liste des conflits que vous devrez résoudre avant de poursuivre la fusion.
Résolution des conflits de fusion
Vous avez deux options pour résoudre un conflit de fusion — sélectionner une version à fusionner ou manuellement modifier le contenu.
Sélectionner une version à fusionner
Vous pouvez résoudre un conflit de fusion en sélectionnant une version que vous souhaitez fusionner — soit votre contenu entrant, soit le contenu qui se trouvait précédemment là. Cela vous permet de choisir entre une modification et une autre — soit votre travail récent, soit le contenu original.
Si vous avez affaire à un conflit de fusion qui peut être résolu de cette manière, vous pouvez sélectionner la version que vous souhaitez conserver, et l'autre version sera supprimée.
Modification manuelle
Si vous ne souhaitez pas choisir entre des versions, vous pouvez résoudre un conflit de fusion en modifiant manuellement le conflit. Vous pourrez supprimer les blocs dont vous n'avez pas besoin, ou même les réécrire entièrement. Une fois que vous êtes satisfait des modifications, vous pouvez passer au conflit suivant jusqu'à ce qu'ils soient tous résolus.
Archivage d'une demande de modification
Si vous décidez de ne pas fusionner une demande de modification et souhaitez la retirer de la file d'attente, vous pouvez l'archiver.
Pour archiver une demande de modification, ouvrez-la d'abord. Ensuite, cliquez sur le menu Actions 
à côté du titre de la demande de modification et choisissez Archiver. Vous pouvez trouver et rouvrir les demandes de modification archivées plus tard en ouvrant le Demandes de modification menu et en sélectionnant l'onglet Archivé .
Mis à jour
Ce contenu vous a-t-il été utile ?