Demandes de modification dans un espace

Découvrez comment collaborer sur une seule demande de modification dans un espace — y compris comment 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 les autres travaillent.

Créer une demande de modification

Cliquez sur le bouton Modifier dans l’en-tête de l’espace pour commencer 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 sauvegardé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 plus de contexte sur les changements que vous apportez.

Une fois que vous êtes satisfait de vos modifications, vous pouvez utiliser le bouton dans la barre d’en-tête pour Demander une révision de votre demande de modification, ou Fusionner la modifier 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 instructions que vous lui donnez.

Pour ouvrir une nouvelle demande de modification avec GitBook Agent, cliquez sur l’icône GitBook Agent en haut à droite à côté du bouton « Modifier », et demandez à GitBook d’implémenter les changements que vous souhaitez.

Parmi les choses que vous pouvez lui demander de faire, on trouve :

• 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 le contenu connexe

• + plus

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

Prévisualiser une demande de modification

Vous pouvez prévisualiser les modifications que vous avez apportées dans une demande de modification en cliquant sur l’option Aperçu dans le l’espace. Cela basculera vers un aperçu de votre documentation publiée avec les modifications proposées incluses, afin que vous puissiez voir vos modifications 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 complètement dans un nouvel onglet.

Lorsque vous ouvrez une URL d’aperçu dans un nouvel onglet, vous verrez également la barre d’outils Aperçu en bas de la fenêtre du navigateur. Cette barre d’outils vous permet de revenir rapidement dans GitBook pour afficher, modifier ou commenter la demande de modification, ou ouvrir la version en direct de votre site.

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

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 révision d’une demande de modification

Demandez une révision de votre demande de modification lorsque vous souhaitez que des membres de votre équipe vérifient votre contenu avant que vous ne fusionniez les modifications dans la branche principale.

Sélectionnez l’onglet Aperçu 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 que vous avez apportées en vue de diff.

Ici, vous pouvez ajouter une description à votre demande de modification pour donner du contexte à vos réviseurs, et identifier des personnes spécifiques que vous souhaitez voir vérifier votre travail.

Lorsque vous cliquez sur Demander une révision, le statut de la demande de modification passera à En révision, et toute personne que vous avez identifiée dans votre demande de révision recevra une notification.

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

Ajouter GitBook Agent en tant que réviseur à votre demande de modification et il pourra vérifier votre contenu pour des erreurs d’orthographe, de grammaire et de style, suggérer des améliorations et plus encore.

Si vous n’identifiez personne dans votre demande de révision, tous ceux qui ont des permissions de réviseur recevront une notification concernant votre demande. Si aucun réviseur n’est présent dans l’espace, le rôle immédiatement supérieur au réviseur sera notifié.

Vue en diff

Lorsque vous ouvrez l’onglet Modifications dans l’en-tête de l’espace, la vue en diff apparaîtra. La vue en diff met en évidence chaque page et chaque bloc qui ont été modifiés dans une demande de modification. Elle mettra en évidence 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 lorsque vous utilisez la vue en diff :

1. Afficher toutes les pages – C’est le mode par défaut de la vue en 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é édité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é. Cela 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 en 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 dans la branche principale du contenu, créant une version mise à jour et une nouvelle entrée dans l’historique des versions.

Vous pourriez ne pas être en mesure de fusionner une demande de modification si vous n’avez pas les autorisationsdroits appropriés, ou si votre demande de modification n’a pas passé les règle de fusion.

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 y a 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 voulez voir à quoi ressemblent vos modifications et le contenu de la branche principale une fois que tout est réuni.

• Vous devez apporter des modifications au contenu intégré 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 la demande de modification.

Une fois que vous appuyez sur Mettre à jour, tout le contenu de la branche principale est intégré dans votre demande de modification. Vous pouvez rencontrer des conflits 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 à jour et le bouton Mettre à jour disparaît.

Si la branche principale change à nouveau, votre demande de modification sera de nouveau obsolète et le bouton Mettre à jour réapparaîtra.

Demander aux éditeurs de maintenir leurs demandes de modification à jour avant de fusionner est un bon contrôle qualité - cela aide les auteurs à vérifier le contenu exact qui ira dans la branche principale une fois leur demande fusionnée. Vous pouvez l’appliquer avec une règle de fusion.

Résolution 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 morceau de contenu qui n’a pas pu être fusionné automatiquement.

Si cela se produit, un avertissement de conflit s’affichera, ainsi qu’une liste des conflits que vous devrez résoudre avant de poursuivre la fusion.

Vous avez deux options pour résoudre un conflit de fusion — sélectionner une version à fusionner ou modifier manuellement le contenu.

Sélectionner une version à fusionner

Vous pouvez résoudre un conflit de fusion en sélectionnant la version que vous souhaitez fusionner — soit votre contenu entrant, soit le contenu qui était précédemment présent. 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 voulez 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.

Archiver une demande de modification

Si vous décidez de ne pas fusionner une demande de modification et que vous 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’onglet Archivé .