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