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

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

あなたがある スペースの範囲内にいるときは、新しい変更リクエストを開いて変更を加えるか、既存の変更リクエストを参照して他の人が何に取り組んでいるかを確認できます。

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

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

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

変更リクエストを作成するときに、タイトルと説明を追加して、行っている変更の背景をより詳しく伝えることができます。

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

GitBook Agent を使って変更リクエストを作成する

GitBook エージェント は、AI の共同作業相手として 変更リクエストを計画し、実装する ことができます。

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

依頼できる内容の例:

  • 使用例を追加する

  • ページのSEOを改善する

  • わかりやすさを向上させる

  • 一貫性を確認する

  • টাইपोとスペルミスを修正する

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

  • + さらに多く

次へ移動します GitBook Agent で執筆する をご覧ください。

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

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

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

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

circle-info

変更リクエストをプレビューできるのは、 公開済みドキュメントサイト.

circle-exclamation

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

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

Azure 概要 スペースのヘッダーバーにある

タブを開くと、diffビューを含む変更リクエストの概要が表示されます。

ここで変更リクエストに説明を追加してレビュー担当者に背景を伝えたり、作業を確認してほしい特定の人をタグ付けしたりできます。 レビューを依頼するをクリックすると、変更リクエストのステータスは レビュー中に変わり、レビュー依頼でタグ付けされた人には通知が届きます。

変更にレビューが不要で、適切な 権限を持っており、ブロックする マージルールがない場合は、代わりに変更を直接メイン版にマージできます。

circle-info

GitBook Agent をレビュー担当者として追加する 変更リクエストに追加すると、スペル、文法、スタイルガイドのエラーを確認し、改善案などを提案できます。

circle-exclamation

diffビュー

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

diffビューを使うときのオプションは 2 つあります:

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

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

に切り替えて 変更 タブで、任意の変更リクエストの diffビューを確認できます。

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

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

必要な 権限権限がない場合、または変更リクエストが組織やスペースの マージルール.

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

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

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

  • 変更内容と main 上のコンテンツが、すべて合わせるとどのように見えるか確認したい。

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

これを行うには、変更リクエスト画面のヘッダーにある 更新 を押します。

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

main ブランチが再び変更されると、変更リクエストは再び最新ではない状態になり、更新ボタンが表示されます。

編集者にマージ前の変更リクエストを最新に保ってもらうよう求めることは、品質管理として有効です。変更リクエストがマージされたときに main ブランチに入る正確な内容を著者が確認するのに役立ちます。これは マージルール.

マージ競合を解決する

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

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

マージ競合を解決する方法は 2 つあります — マージする版を選択する または 手動で コンテンツを編集する.

マージする版を選択する

マージ競合は、マージしたい版を選ぶことで解決できます。取り込むコンテンツか、以前そこにあったコンテンツのどちらかです。これにより、最近の作業か元のコンテンツか、2 つの変更のどちらかを選べます。

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

手動で編集する

版を選びたくない場合は、競合を手動で編集して解決できます。不要なブロックを削除したり、完全に書き直したりもできます。変更に満足したら、すべて解決するまで次の競合に進めます。

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

変更リクエストをマージしないことにしてキューから हटしたい場合は、アーカイブできます。

変更リクエストをアーカイブするには、まずそれを開きます。次に、変更リクエストのタイトルの横にある アクションメニュー The Actions menu icon in GitBook をクリックして アーカイブを選択します。後で 変更リクエスト メニューを開き、 アーカイブ済み タブを選ぶと、アーカイブされた変更リクエストを見つけて再度開けます。

最終更新

役に立ちましたか?