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

スペース内の単一の変更リクエストでの共同作業について—レビュー、競合の解決、マージ方法を含む

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

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

をクリックします 編集 ボタンを スペースのヘッダー で新しいチェンジリクエストを開始します。

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

チェンジリクエストを作成するとき、変更内容についての文脈を提供するためにタイトルと説明を追加できます。

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

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

GitBook Agent はAIのチームメイトで、 チェンジリクエストを計画・実行する ことが可能です。指示に基づいて動作します。

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

例えば以下のようなことを依頼できます：

• 使用例の追加

• ページのSEO改善

• 明確さの向上

• 一貫性の確認

• 誤字脱字やスペルミスの修正

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

• ＋さらに

へ移動してください GitBook Agentでの執筆 で詳細を確認できます。

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

チェンジリクエストで行った変更は、をクリックしてプレビューできます プレビュー オプションを スペースのヘッダー選択します。これにより公開済みドキュメントのプレビューが提案された変更を反映した形で表示され、公開ドキュメント全体の文脈で変更内容を確認できます。

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

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

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

コンテンツが共有リンクや認証アクセスを使って公開されている場合、プレビュー機能は表示されません。

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

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

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

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

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

変更にレビューが不要で、適切な 権限を持っており、かつブロックするような マージルールがない場合は、変更を直接メインバージョンにマージすることもできます。

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

レビュワーをレビュー依頼でタグ付けしなかった場合、レビュワー権限を持つ全員に通知が届きます。スペースにレビュワーがいない場合は、レビュワーの上位ロールの人に通知が送られます。

差分表示

を開くと 変更 スペースのヘッダーにあるタブで差分表示が現れます。差分表示はチェンジリクエストで編集されたすべてのページとブロックをハイライトします。目次では編集されたページをハイライトし、各ページでは追加、編集、削除された特定のブロックを表示します。

差分表示には2つのオプションがあります：

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

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

次のタブに切り替えて、 変更 任意のチェンジリクエストで差分表示を確認できます。

チェンジリクエストをマージする

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

に新しいエントリが作成されます。適切な 権限権限がない場合や、チェンジリクエストが組織やスペースの マージルール.

を通過していない場合は、マージできないことがあります。

チェンジリクエストの更新

チェンジリクエスト内で作業している間に、他の貢献者がスペースのメインブランチを変更することがあります。このような場合、チェンジリクエストは「古くなっている」と見なされます — メインブランチに存在するがチェンジリクエスト内では見えていないコンテンツがあるという状態です。

• この新しいコンテンツをチェンジリクエストに取り込みたい場合があります。これは次のようなときに有用です：

• すべてを合わせたときにあなたの変更とメインのコンテンツがどのように見えるか確認したいとき。

取り込んだコンテンツに対してチェンジリクエストの一部として変更を加える必要があるとき。 これを行うには、チェンジリクエスト画面のヘッダーにある 更新

を押します。 これを行うには、チェンジリクエスト画面のヘッダーにあるを押すと、メインブランチのすべてのコンテンツがチェンジリクエストに取り込まれます。更新時に競合が発生することがあります — 競合はチェンジリクエスト内で解決できます。競合が解決されるとチェンジリクエストは最新の状態と見なされ、更新ボタンは消えます。

メインブランチが再度変更されると、チェンジリクエストは再び古くなり、更新ボタンが表示されます。

編集者にマージ前にチェンジリクエストを最新の状態にしてもらうよう求めることは良い品質管理です — これにより著者はチェンジリクエストがマージされたときにメインブランチに反映される正確なコンテンツを確認できます。これを強制するには、 マージルール.

を使用できます。

マージの競合を解決する

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

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

コンテンツを編集する

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

マージするバージョン（あなたの着信コンテンツか、以前に存在していたコンテンツ）を選択することでマージ競合を解決できます。これにより、最近の変更と元のコンテンツのどちらか一方を選択できます。

この方法で解決できるマージ競合に直面している場合、保持したいバージョンを選択すると、もう一方のバージョンは削除されます。

手動で編集する

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

チェンジリクエストをアーカイブする

チェンジリクエストをマージしないことに決め、キューから削除したい場合はアーカイブできます。 チェンジリクエストをアーカイブするには、まずそれを開きます。次に、 アクションメニュー をチェンジリクエストのタイトルの横にあるメニューをクリックし、アーカイブ を選択します。アーカイブしたチェンジリクエストは後で チェンジリクエスト メニューを開き、 アーカイブ済み