リポジトリ

リポジトリは、Guidebook Cloudでドキュメントを管理する基本単位です。各リポジトリはGitHubリポジトリと連携し、ドキュメントの自動ビルド・デプロイを行います。

リポジトリとは

Guidebook Cloudにおけるリポジトリは、1つのドキュメントセットを表します。GitHubリポジトリと1対1で対応し、以下の機能を提供します:

  • GitHubへのプッシュ時の自動ビルド
  • ブランチごとのプレビュー環境
  • リポジトリ固有のアクセス制御

リポジトリのインポート

前提条件

リポジトリをインポートするには、以下の条件を満たす必要があります:

  • 組織の管理者(Admin)以上の権限
  • GitHub Appがインストール済み

インポート手順

  1. サイドバーの「リポジトリ」を開く
  2. 「リポジトリをインポート」をクリック
  3. GitHubリポジトリを選択
  4. 以下の設定を行う:
    • 名前: 表示名
    • スラッグ: URLに使用される識別子
    • ドキュメントパス: GitHubリポジトリ内のドキュメントディレクトリ
    • デフォルトブランチ: 主要なブランチ名
  5. 「インポート」をクリック

book.json の自動検出

GitHubリポジトリを選択すると、book.json ファイルの位置が自動的に検出されます。検出された場合、ドキュメントパスのデフォルト値として設定されます。

例えば、docs/book.json が見つかった場合、ドキュメントパスは自動的に docs/ に設定されます。

リポジトリの設定

基本設定

設定項目説明
名前リポジトリの表示名
スラッグURLに使用される識別子(変更不可)
デフォルトブランチ主要なドキュメントブランチ

リポジトリの管理

ビルド履歴

各リポジトリのビルド履歴を確認できます:

  1. リポジトリの詳細ページを開く
  2. 「ビルド」タブをクリック
  3. 各ビルドのステータス、ログ、所要時間を確認

手動ビルド

自動ビルドに加えて、手動でビルドをトリガーできます:

  1. リポジトリの詳細ページを開く
  2. 「ビルドを実行」ボタンをクリック
  3. ビルド対象のブランチを選択
  4. 「実行」をクリック

リポジトリの削除

リポジトリを削除すると、すべてのブランチとビルド成果物が削除されます。

  1. リポジトリの設定ページを開く
  2. 「リポジトリを削除」をクリック
  3. 確認ダイアログでリポジトリ名を入力
  4. 「削除」をクリック

注意: この操作は取り消せません。

関連項目