GitLab Syncを有効にする

GitLabリポジトリをGitBookと同期する

このガイドでは、GitLab 上のリポジトリを使って GitBook サイトをセットアップする手順を説明します。

GitLab Sync の設定オプション。

1

サイトで Git Sync を開く

サイトから、サイドバーで Git Sync を開きます。

2

GitLab を接続

GitLab のユーザー設定で Personal Access Token を作成します。を有効にします api, read_repositoryを読み取り、 write_repositoryその後、トークンを GitBook に入力します。

トークンにロールがある場合は、選択してください メンテナー または 管理.

3

リポジトリとブランチを選択

次の項目の下で ソースリポジトリ、ドキュメントが含まれているリポジトリを選択します。GitBook が同期するブランチを選択してください。そのブランチが存在しない場合、GitBook は初回同期時に作成します。

リポジトリが見つかりませんか？ Personal Access Token に必要なスコープとリポジトリアクセスがあることを確認してください。

もしあなたの main ブランチが保護されている場合は、Git Sync 用に別のブランチを選択してください。そのブランチを次へマージできます main 保護を維持したまま。

4

初回同期の方向を選択

初回同期のソース・オブ・トゥルースを選択します。 方向を入れ替え リポジトリの内容で GitBook の内容を置き換える場合。

GitLab → GitBook では、サイトのコンテンツが置き換えられる場合があります。 同期を開始する前に、リポジトリ、ブランチ、方向を確認してください。置き換えても安全な送信先コンテンツであることを確認してください。

5

プロジェクトディレクトリを設定

ドキュメントがサブディレクトリにある場合は、 プロジェクトディレクトリの下に入力してください。GitBook はサイトの docs.yaml ファイルをこのディレクトリに保存します。ドキュメントが monorepo.

6

スペースをマッピング

次の項目の下で コンテンツのマッピングで、各スペースをリポジトリ内のディレクトリに割り当てます。 ./ プロジェクトディレクトリからの相対パスには / リポジトリのルートからのパスには

7

を使用します。新しくリンクされたスペースは自動的に同期されます。

必要に応じて、エージェント指示ファイル、コミットメッセージテンプレート、またはフォークのプレビューを設定します。

8

サイトを同期

クリックして 同期 して初回同期を開始します。

9

書き込みとコミット

GitBook で変更リクエストをマージして、その変更を GitLab にコミットします。GitLab へのコミットは GitBook に同期されて戻ります。

サイト全体の Git Sync からスペースを除外する

サイトの Git Sync のコンテンツマッピングで、除外したいスペースの横にある削除アイコンをクリックします。その後、そのスペースから Git Sync を設定できます。

サイトにすでに Git Sync がある場合、GitBook はスコープを選択するよう求めます:

• サイト全体の Git Sync にスペースを追加するには、サイトのリポジトリとブランチを選択します。
• Space Git Sync を設定するには、独立したリポジトリとブランチを選択します。

サイトで Git Sync を使用していない場合、GitBook はそのスペースに対して個別に Git Sync を設定します。

単一のスペースに Git Sync を設定するには、同期したいスペースで セットアップ の横にある Git Sync の スペースヘッダーをクリックします。プロバイダー一覧から GitLab Sync、そして 設定.