スペース内の変更要求

スペース内の単一の変更要求で共同作業する方法 — レビュー、競合の解決、マージ方法などを含む

あなたが スペースの中にいるとき、新しいチェンジリクエストを開いて変更を行うか、既存のチェンジリクエストを参照して他の人が何に取り組んでいるかを見ることができます。

チェンジリクエストの作成

ライブ編集が無効になっているスペース内で、 編集 ボタンをクリックします。 スペースヘッダー をクリックして新しいチェンジリクエストを開始します。

これにより新しいチェンジリクエストが開き、必要に応じてコンテンツを編集または削除できます。変更は自動的に保存され、他の人もチェンジリクエストに参加してリアルタイムで共同作業できます。

チェンジリクエストを作成するときは、変更の背景を説明するためにタイトルと説明を追加できます。

変更に満足したら、ヘッダーバーのボタンを使って レビューを依頼する を行うか、 マージ それを直接メインブランチに取り込むことができます。

GitBook Agentでチェンジリクエストを作成する

GitBook エージェント は、次のことができるAIのチームメイトです チェンジリクエストを計画し実行する あなたが与える指示に基づいて。

GitBook Agentで新しいチェンジリクエストを開くには、右上の「編集」ボタンの隣にあるGitBook Agentアイコンをクリックし、実装したい変更をGitBookに依頼してください。

頼めることの一部には次のようなものがあります:

  • 使用例を追加

  • ページのSEOを改善

  • 明確さを向上

  • 一貫性をチェック

  • タイプミスや綴りの誤りを修正する

  • 関連コンテンツにリンク

  • + その他

へ移動してください GitBook Agentを使ったライティング をご覧ください。

チェンジリクエストのプレビュー

チェンジリクエストで行った変更は、 変更を強調表示します。 オプションを スペースヘッダーでクリックすることでプレビューできます。これにより提案された変更を含む公開ドキュメントのプレビューに切り替わり、公開ドキュメント全体の文脈で変更を確認できます。

の下にある 変更を強調表示します。 ボタンはサイトプレビューのURLです。これをクリックするとサイトプレビューが新しいタブで全画面表示されます。

プレビューURLを新しいタブで開くと、 プレビューツールバー がブラウザウィンドウの下部に表示されます。このツールバーを使うと、チェンジリクエストの表示、編集、コメントやサイトのライブバージョンの表示に素早く戻ることができます。

circle-info

チェンジリクエストのプレビューは、に追加されたスペースのみで行えます 公開されたドキュメントサイト.

circle-exclamation

チェンジリクエストでレビューを依頼する

チェンジリクエストをメインブランチにマージする前にチームのメンバーに内容を確認してもらいたい場合、レビューを依頼します。

を選択します 概要 スペースのヘッダーバーにあるタブを開くと、チェンジリクエストの概要が表示されます — 差分表示を含むあなたが行ったすべての変更が確認できます。

ここでレビュー担当者にコンテキストを伝えるための説明をチェンジリクエストに追加したり、確認してほしい特定の人にタグ付けしたりできます。

をクリックすると レビューを依頼するチェンジリクエストのステータスは レビュー中に変わり、レビュー依頼でタグ付けした人全員に通知が届きます。

変更がレビューを必要とせず、あなたに適切な 権限があり、ブロックするような マージルールがない場合は、代わりに変更を直接メインバージョンにマージできます。

circle-info

GitBook Agentをレビュー担当者として追加する とあなたのチェンジリクエストにタグ付けすると、スペル、文法、スタイルガイドの誤りをチェックしたり、改善案を提案したりすることができます。

circle-exclamation

差分表示

スペースヘッダーで 変更 タブを開くと差分表示が現れます。差分表示は、変更リクエストで編集されたすべてのページとブロックを強調表示します。目次内の編集されたページや、ページ上で追加、編集、削除された特定のブロックを表示します。

差分表示を使用する際のオプションは2つあります:

  1. すべてのページを表示 – これは差分表示のデフォルトモードで、目次に変更されたページと変更されていないページの両方を表示します。スペース全体の文脈でどのページが編集されたかを確認するのに適しています。

  2. 変更されたページのみを表示 – このモードは目次に変更されたページのみを表示し、変更されたコンテンツに集中するのに役立ちます。多くのページやサブページがある大きなスペースでは特に有用です。

任意の変更リクエストで差分表示を確認するには 変更 タブに切り替えることができます。

変更リクエストのマージ

変更リクエストをマージすると、変更リクエストの変更がコンテンツのメインブランチに加えられ、更新されたバージョンとスペースの バージョン履歴.

適切な 権限がない場合、または組織やスペースの マージルール.

を変更リクエストが通過していない場合、変更リクエストをマージできないことがあります。

マージコンフリクトの解決

変更リクエストをマージしようとすると、メインのコンテンツとマージしようとしているコンテンツの間にコンフリクトが発生することがあります。最も単純な形では、コンフリクトは自動的にマージできなかったコンテンツの断片です。

このような場合、コンフリクトのアラートと、マージを続行する前に解決する必要があるコンフリクトの一覧が表示されます。 マージコンフリクトを解決する際には2つの選択肢があります — または バージョンを選択してマージする 手動で.

コンテンツを編集する

バージョンを選択してマージする

マージコンフリクトは、マージしたいバージョン(あなたの差分として入ってきた内容)か、以前からあったコンテンツのどちらかを選択することで解決できます。これにより、最近の変更か元のコンテンツか、どちらの変更を採用するか選べます。

この方法で解決できるマージコンフリクトの場合、保持したいバージョンを選択すると、もう一方のバージョンは削除されます。

手動で編集する

バージョンのどちらかを選びたくない場合は、コンフリクトを手動で編集して解決できます。不要なブロックを削除したり、完全に書き直したりできます。変更に満足したら次のコンフリクトに進み、すべてが解決されるまで続けます。

変更リクエストのアーカイブ

変更リクエストをマージせずにキューから取り除きたい場合は、アーカイブできます。 操作メニュー The Actions menu icon in GitBook 変更リクエストをアーカイブするには、まずそれを開きます。次に変更リクエストのタイトルの横にある をクリックして「アーカイブ」 を選択します。アーカイブした変更リクエストは後で メニューを開き、 「アーカイブ済み」 タブを選択して確認できます。

最終更新

役に立ちましたか?