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

スペース内の 1 つの変更リクエストで共同作業する方法を学びます。レビュー、競合解決、マージの方法も含みます

次の中にいるとき、 スペースでは、新しい変更リクエストを開いて変更を加えたり、既存の変更リクエストを閲覧して他の人が何に取り組んでいるかを確認したりできます。

変更リクエストを作成する

次をクリックします 編集 ボタンを スペースヘッダー で、新しい変更リクエストを開始します。

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

変更リクエストを作成する際には、タイトルと説明を追加して、行っている変更についてより多くの文脈を提供できます。

変更リクエストを次のようなソースにリンクすることもできます:

• Linear の課題

• GitHub のプルリクエストまたは Issue

• Jira チケット

• 一般的な URL

これらのリンクは変更リクエスト上に表示されるため、レビュアーは作業の出所までたどることができます。

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

GitBook Agent で変更リクエストを作成する

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

GitBook Agent で新しい変更リクエストを開くには、右上隅の「編集」ボタンの横にある GitBook Agent アイコンをクリックし、必要な変更を実装するよう GitBook に依頼します。

依頼できることの例は次のとおりです:

• 使用例を追加する

• ページの SEO を改善する

• 明確さを高める

• 一貫性を確認する

• タイプミスやスペルミスを修正する

• 関連コンテンツをリンクする

• + さらに多く

次へ進んでください GitBook Agent で書く 詳細はこちら。

変更リクエストをプレビューする

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

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

プレビュー URL を新しいタブで開くと、次も表示されます プレビューツールバー がブラウザウィンドウの下部に表示されます。このツールバーを使うと、GitBook にすばやく戻って変更リクエストを表示、編集、コメントしたり、サイトのライブ版を開いたりできます。

変更リクエストをプレビューできるのは、次に追加されたスペースのみです 公開ドキュメントサイト.

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

変更リクエストでレビューを依頼する

変更をメインブランチにマージする前に、チームメンバーにコンテンツを確認してもらいたい場合は、変更リクエストでレビューを依頼します。

次を選択します 概要 タブをスペースヘッダーバーで開くと、変更リクエストの概要が表示されます。これには、diff 表示ですべての変更内容が含まれます。

ここでは、レビュアーに文脈を伝えるために変更リクエストへ説明を追加したり、作業を確認してほしい特定の人をタグ付けしたりできます。

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

変更にレビューが不要で、適切な 権限があり、妨げとなる マージルールがない場合は、代わりに変更を直接メインバージョンへマージできます。

GitBook Agent をレビュアーとして追加する を変更リクエストに行うと、スペル、文法、スタイルガイドの誤りをチェックし、改善提案などをしてくれます。

レビュー依頼で誰もタグ付けしない場合、レビュアー権限を持つ全員に依頼の通知が届きます。スペース内にレビュアーがいない場合は、レビュアーの一つ上のロールに通知されます。

差分表示

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

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

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

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

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

変更リクエストをマージする

変更リクエストをマージすると、その変更内容がコンテンツのメインブランチに追加され、更新されたバージョンとスペースの次の場所に新しいエントリが作成されます バージョン履歴.

適切な 権限がない場合、または変更リクエストが組織またはスペースの次を通過していない場合は、変更リクエストをマージできないことがあります マージルール.

変更リクエストを更新する

変更リクエスト内で作業している間に、他のコントリビューターがスペースのメインブランチを変更している場合があります。これが起こると、変更リクエストは「古い状態」と見なされます。つまり、メインブランチにはあるが変更リクエスト内では見えていないコンテンツが存在します。

この新しいコンテンツを変更リクエストに取り込みたい場合があります。これは次のような場合に役立ちます:

• 自分の変更と main 上のコンテンツを、すべてまとめたときにどう見えるか確認したい。

• 変更リクエストの一部として、取り込んだコンテンツに変更を加える必要がある。

これは次を押すことで行えます 更新 を変更リクエスト画面のヘッダーで。

次を押すと 更新、メインブランチのすべてのコンテンツが変更リクエストに取り込まれます。更新時に競合が発生することがありますが、変更リクエスト内で解決できます。競合が解決されると、変更リクエストは最新と見なされ、Update ボタンは消えます。

メインブランチが再び変更されると、変更リクエストは再度古い状態になり、Update ボタンが表示されます。

マージ前に編集者の変更リクエストを最新状態にしておくよう求めるのは、良い品質管理です。これは、変更リクエストがマージされたときにメインブランチへ入る正確なコンテンツを作成者が確認する助けになります。これは次で強制できます マージルール.

マージ競合を解決する

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

この場合、競合アラートと、マージを続行する前に解決する必要がある競合の一覧が表示されます。

マージ競合を解決するには 2 つの選択肢があります — マージするバージョンを選択する または 手動で コンテンツを編集する.

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

マージ競合は、マージしたいバージョンを選択することで解決できます。受け入れる側のコンテンツか、以前からあったコンテンツのどちらかです。これにより、ある変更と別の変更、つまり最近の作業か元のコンテンツかを選べます。

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

手動編集

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

変更リクエストをアーカイブする

変更リクエストをマージしないと決めてキューから取り除きたい場合は、アーカイブできます。

変更リクエストをアーカイブするには、まずそれを開きます。次に、 アクションメニュー を変更リクエストのタイトルの横でクリックし、次を選択します アーカイブ。アーカイブ済みの変更リクエストは、後で 変更リクエスト メニューを開いて アーカイブ済み タブを選択することで見つけて再度開くことができます。