変更リクエスト

変更リクエストを通じてコンテンツ編集を共同で進めます

変更リクエストは、メインコンテンツのコピーです。これはブランチという概念に基づいており、GitHub のプルリクエストや GitLab のマージリクエストを使ったことがある人にはなじみのある仕組みです。

変更リクエストでは、コンテンツの編集、更新、削除、変更内容のレビュー依頼を行い、最後にそれらをメイン版へマージできます。

サイト全体の公開中の変更リクエストを参照・管理するには、 変更リクエスト画面.

変更リクエストを通じてコンテンツを編集します。

差分ビューで変更を確認

〜を開き、 変更 タブで、変更リクエスト内の編集内容を確認します。すべてのページを文脈の中で確認することも、変更されたページだけに絞って確認することもできます。

エディタ下部のフローティング差分ナビゲーターを使うと、変更されたブロック間を移動したり、差分のある次のページへ進んだり、利用可能なレビュー操作で最後の変更からレビューを完了したりできます。

既定では、変更は「分割ビュー」で表示されます。左側にページの「変更前」バージョン、右側に「変更後」の状態が表示されます。単一カラムのレイアウトで変更をインライン表示したい場合は、目次パネル右上の差分モードボタンをクリックしてください。

変更リクエストを作成してマージする

1

変更リクエストを開く

コンテンツを編集するには、変更リクエストを開きます。開く方法はいくつかあります。

• クリックして 編集 セクションの右上隅にある。
• GitBook Agent に依頼して作成してもらいます。
• GitBook Agent は、ドキュメントの不足を検知すると自動的に作成することがあります。

手動で開いた場合、GitBook が変更リクエストを作成し、エディタで開きます。

2

変更を加える

エディタで直接コンテンツを編集するか、GitBook Agent と作業します。

先へ進む前に変更内容を確認してください。レビューを依頼する準備ができるまで、編集を続けられます。

3

レビューを依頼する

〜を開き、 概要 タブを開き、1人以上のレビュー担当者をタグ付けします。

レビュー担当者は、変更を承認したり、コメントを残したり、追加の編集を依頼したりできます。誰もタグ付けしない場合は、そのセクションでレビュー権限を持つ全員に通知されます。セクションにレビュー担当者がいない場合は、代わりに編集者と管理者に通知されます。

誰かが変更を依頼した場合は、マージする前に変更リクエストを更新してください。GitBook Agent に変更リクエストのレビューを依頼することもできます。

4

マージ

変更リクエストが承認されたら、 概要 タブを開き、 マージ.

GitBook は変更内容をすぐに公開中のドキュメントに反映します。セクションでマージルールを使用している場合、GitBook はマージ前にそれらを確認します。

マージは元に戻せません。内容を元に戻したり調整したりするには、新しい変更リクエストを開いてください。

変更リクエストの使い方

変更リクエスト画面

組織全体の変更リクエストを表示・管理する

スペース内の変更リクエスト

1つのスペース内で変更リクエストを作成し、レビューする