スペース内の変更リクエスト
スペース内の単一の変更リクエストで共同作業する方法について学びます。レビュー、競合解決、マージを含みます
次の中にいる場合 スペースでは、新しい変更リクエストを開いて変更を加えたり、既存の変更リクエストを参照して他の人が何に取り組んでいるかを確認したりできます。
変更リクエストの作成
次をクリックします 編集 内のボタン スペースヘッダー をクリックして、新しい変更リクエストを開始します。
これにより新しい変更リクエストが開き、必要に応じてコンテンツを編集または削除できます。変更内容は自動的に保存され、他の人も変更リクエストに参加してリアルタイムで共同作業できます。
変更リクエストを作成する際には、タイトルと説明を追加して、行っている変更についてより多くのコンテキストを提供できます。
変更リクエストをソースにリンクすることもできます。これには次が含まれます:
Linear の課題
GitHub のプルリクエストまたは Issue
Jira チケット
一般的な URL
これらのリンクは変更リクエストに表示されるため、レビュアーは作業の起点までたどることができます。
GitBook Agent を使った変更リクエストの作成
GitBook Agent は、 変更リクエストを計画し実装する ことができる AI チームメイトで、与えた指示に基づいて動作します。
GitBook Agent で新しい変更リクエストを開くには、右上隅の「編集」ボタンの横にある GitBook Agent アイコンをクリックし、必要な変更を実装するよう GitBook に依頼します。
依頼できることの例:
使用例を追加する
ページの SEO を改善する
明確さを高める
一貫性を確認する
タイプミスやスペルミスを修正する
関連コンテンツをリンクする
＋その他
以下をご覧ください GitBook Agent を使った執筆 で詳しく確認できます。
変更リクエストのプレビュー
変更リクエストで行った変更は、 プレビュー オプションを、 スペースヘッダー。これにより、提案された変更を含む公開済みドキュメントのプレビューに切り替わるため、公開ドキュメント全体の文脈の中で変更を確認できます。
次の下には、 プレビュー ボタンの下には、サイトプレビュー用の URL があります。これをクリックすると、サイトプレビューが新しいタブで完全表示されます。
プレビュー URL を新しいタブで開くと、 プレビューツールバー がブラウザーウィンドウの下部に表示されます。このツールバーを使うと、GitBook にすばやく戻って変更リクエストを表示・編集・コメントしたり、サイトのライブ版を開いたりできます。
次に追加されたスペースの変更リクエストのみプレビューできます 公開ドキュメントサイト.
コンテンツが共有リンクまたは認証付きアクセスで公開されている場合、プレビュー機能は表示されません。
変更リクエストでレビューを依頼する
変更をメインブランチにマージする前にチームメンバーにコンテンツを確認してもらいたい場合は、変更リクエストでレビューを依頼します。
次を選択します 概要 タブをスペースのヘッダーバーで開くと、差分表示ですべての変更内容を含む変更リクエストの概要が表示されます。
次を使用します 概要 タブでコンテキストとレビュアーを追加します。エディターで差分を確認するには、 変更 タブに切り替えます。そのビューでは、差分のあるページにインジケーターが表示され、フローティング差分ナビゲーションコントロールにより変更されたブロック間をすばやく移動できます。
ここでは、変更リクエストに説明を追加してレビュアーにコンテキストを提供し、作業を確認してほしい特定の人をタグ付けできます。
次をクリックすると レビューを依頼、変更リクエストのステータスは レビュー中に変わり、レビュー依頼でタグ付けした全員に通知が送られます。
GitBook Agent をレビュアーとして追加する を変更リクエストに追加すると、スペル、文法、スタイルガイドの誤りをチェックし、改善案を提案するなどができます。
レビュー依頼で誰もタグ付けしない場合、スペース内でレビュアー権限を持つ全員に通知が送られます。スペースにレビュアーがいない場合は、レビュアーの一つ上のロールに通知が送られます。
差分ビュー
ページに差分が含まれている場合、GitBook は中央に浮動表示されるインジケーターも表示します。クリックすると、最初に変更されたブロックまたは要素までスクロールします。
スペースヘッダーで 変更 タブを開くと、GitBook は変更リクエストで編集されたすべてのページとブロックを表示します。左側に以前のバージョン、右側に更新後のバージョンが表示されるため、編集内容を並べて比較しやすくなります。
差分を含むページは目次にもインジケーターが表示されるため、大規模な変更リクエストも確認しやすくなります。
エディターの 変更 タブでページをレビューすると、フローティング差分ナビゲーションコントロールにより、ページ全体をスクロールしなくても変更されたブロック間をすばやく移動できます。
差分ビューを使用する際には、2 つのオプションがあります:
すべてのページを表示 — 変更されたページと変更されていないページの両方を目次に表示するため、スペース全体の文脈の中で編集内容を確認できます。
変更されたページのみを表示 — 変更されたページのみを表示するため、編集されたコンテンツに集中できます。
次に切り替えることができます 変更 タブで、任意の変更リクエストの差分ビューを確認できます。
変更リクエストのマージ
変更リクエストをマージすると、変更リクエストの変更がコンテンツのメインブランチに追加され、更新版とスペースの バージョン履歴.
変更リクエストの更新
変更リクエスト内で作業している間に、他のコントリビューターがスペースのメインブランチを変更している場合があります。これが起きると、変更リクエストは「古い状態」と見なされます。つまり、変更リクエスト内では見えていないコンテンツがメインブランチに存在するということです。
次のような場合、この新しいコンテンツを変更リクエストに取り込みたいことがあります:
すべてをまとめたときに、自分の変更と main 上のコンテンツがどのように見えるかを確認したい。
取り込んだコンテンツに対して、変更リクエストの一部として変更を加える必要がある。
これは、 更新 を変更リクエスト画面のヘッダーで押すことで実行できます。
いったん 更新を押すと、メインブランチのすべてのコンテンツが変更リクエストに取り込まれます。更新時に競合が発生することがありますが、変更リクエスト内で解決できます。競合が解決されると、変更リクエストは最新状態と見なされ、更新ボタンは消えます。
メインブランチが再び変更されると、変更リクエストは再度古い状態になり、更新ボタンが表示されます。
マージ前に編集者へ変更リクエストを最新状態にしておくよう求めるのは、優れた品質管理です。変更リクエストがマージされたときにメインブランチへ入る正確な内容を著者が確認する助けになります。これは マージルール.
マージ競合の解決
変更リクエストをマージしようとすると、メインコンテンツとマージしようとしているコンテンツの間に競合が見つかることがあります。最も単純な形では、競合とは自動的にマージできなかったコンテンツの一部です。
これが起きると、競合アラートと、マージを続行する前に解決する必要がある競合の一覧が表示されます。
マージ競合を解決する方法は 2 つあります — マージするバージョンを選択する または 手動で コンテンツを編集する.
マージするバージョンを選択する
マージ競合は、マージしたいバージョンを選択することで解決できます。受け入れる新しいコンテンツか、以前からあったコンテンツのどちらかです。これにより、ある変更と別の変更、つまり最近の作業か元のコンテンツかを選べます。
この方法で解決できるマージ競合に対処している場合は、残したいバージョンを選択でき、もう一方のバージョンは削除されます。
手動編集
バージョンのどちらかを選びたくない場合は、競合を手動で編集してマージ競合を解決できます。不要なブロックを削除したり、完全に書き直したりすることもできます。変更内容に問題がなければ、次の競合に進み、すべてが解決されるまで続けることができます。
変更リクエストのアーカイブ
GitBook では変更リクエストを削除できませんが、代わりにアーカイブできます。
変更リクエストをアーカイブするには:
次を開きます 変更リクエスト タブ。
アーカイブしたい変更リクエストを選択します。
次をクリックします アクション メニュー
を変更リクエストのタイトルの横で開き、次を選択します アーカイブ.
アーカイブした変更リクエストを見つけて再度開くには、 変更リクエスト メニューを開き、次を選択します アーカイブ済み タブ。
最終更新
役に立ちましたか？