Demandes de modification dans un espace
Découvrez comment collaborer sur une seule demande de modification dans un espace — y compris comment la revoir, résoudre les conflits et fusionner
Lorsque vous vous trouvez dans un espace, vous pouvez effectuer des modifications en ouvrant une nouvelle demande de modification, ou parcourir les demandes de modification existantes pour voir sur quoi travaillent les autres personnes.
Créer une demande de modification
Cliquez sur le Modifier bouton dans l' en-tête de l’espace pour lancer une nouvelle demande de modification.
Cela ouvrira une nouvelle demande de modification, dans laquelle 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.
Lorsque vous créez une demande de modification, vous pouvez ajouter un titre et une description afin de fournir plus de contexte sur les modifications que vous apportez.
Vous pouvez également associer la demande de modification à une source, notamment :
tickets Linear
pull requests ou issues GitHub
tickets Jira
URLs générales
Ces liens apparaissent sur la demande de modification, afin que les relecteurs puissent retracer l’origine du travail.
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 directement dans la branche principale.
Créer une demande de modification avec GitBook Agent
GitBook Agent est un coéquipier IA qui peut planifier et mettre en œuvre des demandes de modification à partir de n’importe quelles instructions que vous lui donnez.
Pour ouvrir une nouvelle demande de modification avec GitBook Agent, cliquez sur l’icône GitBook Agent dans le coin supérieur droit, à côté du bouton « Modifier », puis demandez à GitBook d’appliquer les modifications souhaitées.
Voici quelques exemples de ce que vous pouvez lui demander de faire :
Ajouter des exemples d’utilisation
Améliorer le référencement de la page
Améliorer la clarté
Vérifier la cohérence
Corriger les fautes de frappe et d’orthographe
Lier du contenu connexe
+ et plus encore
Rendez-vous sur Rédiger avec GitBook Agent pour en savoir plus.
Prévisualiser une demande de modification
Vous pouvez prévisualiser les modifications apportées dans une demande de modification en cliquant sur l' Aperçu option dans la en-tête de l’espace. Cela basculera vers un aperçu de vos docs publiés avec les modifications proposées incluses, afin que vous puissiez voir vos changements dans le contexte complet de votre documentation publiée.
Sous le Aperçu bouton se trouve une URL pour l’aperçu de votre site. Cliquez dessus pour ouvrir votre aperçu du site en entier dans un nouvel onglet.
Lorsque vous ouvrez une URL d’aperçu dans un nouvel onglet, vous verrez également la barre d’outils d’aperçu en bas de la fenêtre du navigateur. Cette barre d’outils vous permet de revenir rapidement dans GitBook pour consulter, modifier ou commenter la demande de modification, ou ouvrir la version en ligne de votre site.
Si votre contenu est publié via des liens de partage ou un accès authentifié, la fonction d’aperçu n’apparaîtra pas.
Demander une relecture sur 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.
Sélectionnez l' Vue d’ensemble onglet dans la barre d’en-tête de l’espace pour ouvrir un aperçu de votre demande de modification — y compris toutes les modifications apportées dans la vue diff.
Ici, vous pouvez ajouter une description à votre demande de modification pour donner du contexte à vos relecteurs, et mentionner des personnes précises 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 révision, et toute personne que vous avez mentionnée dans votre demande de relecture recevra une notification.
Si vos modifications ne nécessitent pas de relecture, si vous disposez des autorisationsappropriées, et si vous n’avez aucune règle de fusionbloquante, vous pouvez plutôt fusionner directement vos modifications dans la version principale.
Si vous ne mentionnez personne dans votre demande de relecture, toute personne disposant des autorisations de relecteur dans l’espace recevra une notification. Si l’espace n’a aucun relecteur, le rôle suivant au-dessus de relecteur recevra la notification.
Vue diff
Lorsque vous ouvrez l' Modifications onglet dans l’en-tête de l’espace, la vue diff apparaît. La vue diff met en évidence chaque page et chaque 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 affichera les blocs spécifiques qui ont été ajoutés, modifiés ou supprimés.
Il existe deux options lorsque vous utilisez la vue diff :
Afficher toutes les pages – C’est le mode par défaut de la vue diff, qui affiche à 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 tout 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é. C’est particulièrement utile dans les grands espaces avec de nombreuses pages et sous-pages.
Vous pouvez passer à l' Modifications onglet pour vérifier la vue diff dans n’importe quelle demande de modification.
Fusionner une demande de modification
La fusion d’une demande de modification ajoutera les modifications de la demande de modification à la branche principale du contenu, créant une version mise à jour et une nouvelle entrée dans l' historique des versions.
Vous ne pourrez peut-être pas fusionner une demande de modification si vous n’avez pas les autorisationsdroits appropriés, ou si votre demande de modification n’a pas respecté les règle de fusion.
Mettre à jour une demande de modification
Pendant que vous travaillez dans une demande de modification, d’autres contributeurs peuvent modifier la branche principale de l’espace. Lorsque cela se produit, votre demande de modification est considérée comme « obsolète » - il existe du contenu dans la branche principale que vous ne voyez pas dans votre demande de modification.
Vous pouvez vouloir intégrer ce nouveau contenu dans votre demande de modification. Cela peut être utile si :
Vous voulez voir à quoi ressemblent vos modifications et le contenu principal une fois que tout est réuni.
Vous devez apporter des modifications au contenu récupéré dans le cadre de votre demande de modification.
Vous pouvez le faire en appuyant sur Mettre à jour dans l’en-tête de l’écran de demande de modification.
Une fois que vous appuyez sur Mettre à jour, tout le contenu de la branche principale est intégré à votre demande de modification. Des conflits peuvent apparaître lors de la mise à jour - vous pourrez les résoudre dans la demande de modification. Une fois les conflits résolus, la demande de modification est considérée comme à jour et le bouton Mettre à jour disparaît.
Si la branche principale change à nouveau, votre demande de modification redeviendra obsolète et le bouton Mettre à jour réapparaîtra.
Demander aux éditeurs de garder leurs demandes de modification à jour avant de fusionner constitue un bon contrôle qualité : cela aide les auteurs à vérifier le contenu exact qui ira dans la branche principale une fois leur demande de modification fusionnée. Vous pouvez imposer cela avec une règle de fusion.
Résoudre les 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 s’affichera, ainsi qu’une liste des conflits que vous devrez résoudre avant de poursuivre la fusion.
Vous avez deux options lorsqu’il s’agit de 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 auparavant là. Cela vous permet de choisir entre une modification et une autre — soit votre travail récent, soit le contenu d’origine.
Si vous faites face à 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.
Modifier manuellement
Si vous ne souhaitez pas choisir entre les 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.
Archiver une demande de modification
Vous ne pouvez pas supprimer une demande de modification dans GitBook, mais vous pouvez l’archiver à la place.
Pour archiver une demande de modification :
Ouvrez l' Demandes de modification onglet.
Sélectionnez la demande de modification que vous souhaitez archiver.
Cliquez sur le Actions menu
à côté du titre de la demande de modification et choisissez Archiver.
Pour trouver et rouvrir une demande de modification archivée, ouvrez le Demandes de modification menu et sélectionnez le Archivé onglet.
Mis à jour
Ce contenu vous a-t-il été utile ?