Demandes de changement dans un espace

Découvrez comment collaborer sur une seule demande de changement dans un espace — y compris comment la réviser, résoudre les conflits et fusionner

Lorsque vous êtes dans un espace, vous pouvez apporter 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 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.

Lors de la création d’une demande de modification, vous pouvez ajouter un titre et une description pour fournir davantage de contexte sur les modifications que vous apportez.

Vous pouvez également lier la demande de modification à une source, notamment :

• Problèmes Linear

• Pull requests ou issues GitHub

• Tickets Jira

• URL 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 la 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 en fonction de toutes les 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 », et demandez à GitBook d’apporter les modifications souhaitées.

Voici quelques exemples de ce que vous pouvez lui demander de faire :

• Ajouter des exemples d’utilisation

• Améliorer le SEO de la page

• Améliorer la clarté

• Vérifier la cohérence

• Corriger les fautes de frappe et d’orthographe

• Lier le contenu associé

• + plus

Rendez-vous à Rédiger avec GitBook Agent pour en savoir plus.

Aperçu d’une demande de modification

Vous pouvez prévisualiser les modifications que vous avez apportées dans une demande de modification en cliquant sur l’ Aperçu option dans l’ en-tête de l’espace. Cela affichera 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 et l’aperçu de votre site s’ouvrira en plein écran 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.

Vous pouvez prévisualiser uniquement les demandes de modification pour les espaces ajoutés à un site de documentation publié.

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 pour 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 une vue d’ensemble de votre demande de modification — y compris toutes les modifications que vous avez apportées dans la vue diff.

Vous pouvez ici ajouter une description à votre demande de modification pour donner du contexte à vos relecteurs, et mentionner des personnes spécifiques dont vous souhaitez qu’elles examinent 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 aurez mentionnée dans votre demande de relecture recevra une notification.

Si vos modifications ne nécessitent pas de relecture, que vous disposez des autorisationsappropriées, et que vous n’avez aucune règle de fusionbloquante, vous pouvez plutôt fusionner directement vos modifications dans la version principale.

Ajoutez GitBook Agent comme relecteur à votre demande de modification et il peut vérifier votre contenu pour détecter les fautes d’orthographe, de grammaire et les erreurs de style, suggérer des améliorations, et plus encore.

Si vous ne mentionnez personne dans votre demande de relecture, toute personne disposant des autorisations de relecteur recevra une notification concernant votre demande. Si aucun relecteur ne se trouve dans l’espace, le rôle supérieur suivant au relecteur sera notifié.

Vue diff

Lorsque vous ouvrez l’ Modifications onglet dans l’en-tête de l’espace, la vue diff s’affiche. 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 lors de l’utilisation de la vue diff :

1. Afficher toutes les pages – Il s’agit du mode par défaut de la vue diff, 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.

2. 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 comportant 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 changements 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.

Il se peut que vous ne puissiez pas fusionner une demande de modification si vous n’avez pas les bonnes autorisationsautorisations règle de fusion.

ou si votre demande de modification n’a pas respecté les

Mise à jour d’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 sur 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 souhaitez voir à quoi ressemblent vos modifications et le contenu sur la branche principale une fois que tout est réuni.

Vous devez apporter des modifications au contenu importé dans le cadre de votre demande de modification. Mettre à jour dans l’en-tête de l’écran de la demande de modification.

Une fois que vous cliquez sur Mettre à jour, tout le contenu de la branche principale est intégré dans 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 maintenir leurs demandes de modification à jour avant la fusion est une bonne mesure de 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 continuer la 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 le contenu entrant, soit le contenu qui se trouvait auparavant. Cela vous permet de choisir entre une modification et une autre — soit votre travail récent, soit le contenu d’origine.

Si vous traitez 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 le modifiant manuellement. Vous pourrez supprimer les blocs dont vous n’avez pas besoin, ou même les réécrire entièrement. Une fois satisfait des modifications, vous pouvez passer au conflit suivant jusqu’à ce qu’ils soient tous résolus.

Archiver 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 retrouver et rouvrir les demandes de modification archivées plus tard en ouvrant le menu Demandes de modification et en sélectionnant l’ Archivé onglet.