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

スペース内で単一の変更リクエストを共同編集する方法を学びます。レビュー、競合の解決、マージの方法も含まれます

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

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

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

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

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

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

• Linearの課題

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

• Jiraチケット

• 一般的なURL

これらのリンクは変更リクエストに表示されるため、レビュー担当者は作業の元の場所をたどれます。

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

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

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

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

たとえば、次のようなことを依頼できます:

• 使用例を追加する

• ページのSEOを改善する

• わかりやすさを高める

• 一貫性を確認する

• 誤字脱字を修正する

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

• さらに

こちらへ GitBook Agent での執筆 で詳しく学べます。

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

変更リクエストで行った変更は、 プレビュー オプションを スペースのヘッダー。

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

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

プレビューできるのは、 公開済みドキュメントサイト.

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

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

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

を選択します 概要 タブをスペースのヘッダーバーで開くと、差分ビューで行ったすべての変更を含む変更リクエストの概要を表示できます。

ここで変更リクエストに説明を追加してレビュー担当者に背景を伝えたり、作業を確認してほしい特定の人をタグ付けしたりできます。

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

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

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

レビュー依頼で誰もタグ付けしない場合、そのスペースのレビュー担当権限を持つ全員に通知が届きます。スペースにレビュー担当者がいない場合は、レビュー担当者の次の上位ロールに通知が届きます。

差分ビュー

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

差分ビューを使用するときは、次の2つのオプションがあります:

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

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

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

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

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

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

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

変更リクエスト内で作業している間に、他の共同編集者がスペースのメインブランチを変更することがあります。その場合、変更リクエストは「古い状態」と見なされます。つまり、メインブランチにはあるのに、変更リクエストには表示されていないコンテンツがあるということです。

この新しいコンテンツを変更リクエストに取り込むとよいでしょう。これは次のような場合に便利です:

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

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

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

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

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

編集者に、マージ前に変更リクエストを最新状態にしておくよう求めるのは、品質管理として有効です。変更リクエストがマージされたときにメインブランチに入る正確な内容を著者が確認しやすくなります。これを マージルール.

マージ競合を解決する

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

その場合は競合アラートが表示され、マージを続行する前に解決すべき競合の一覧が示されます。

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

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

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

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

手動で編集する

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

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

GitBook では変更リクエストを削除できませんが、代わりにアーカイブできます。

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

1. を開きます 変更リクエスト タブ。

2. アーカイブしたい変更リクエストを選択します。

3. をクリックします アクション メニュー を変更リクエストのタイトルの横で開き、 アーカイブ.

アーカイブした変更リクエストを見つけて再度開くには、 変更リクエスト メニューを開いて アーカイブ済み タブ。