Guidebook Cloudでは、GitHubリポジトリのブランチごとに独立したドキュメント環境を提供します。これにより、本番環境に影響を与えずに新しいドキュメントをプレビューできます。
GitHubリポジトリにブランチをプッシュすると、Guidebook Cloudは自動的にそのブランチのドキュメントをビルドし、独立したURLで公開します。
https://guidebook.dev/{org}/{repository}/{branch}/
| ブランチ | URL |
|---|---|
main | https://guidebook.dev/example/docs/main/ |
develop | https://guidebook.dev/example/docs/develop/ |
feature/new-api | https://guidebook.dev/example/docs/feature/new-api/ |
デフォルトブランチは、リポジトリの主要なドキュメントブランチです。通常は main または master を設定します。
注意: デフォルトブランチを変更するには、対象のブランチが既にビルドされている必要があります。
リポジトリ詳細ページの「ブランチ」タブで、すべてのブランチを確認できます:
不要なブランチを削除してストレージを解放できます:
注意:
同じブランチに対する複数のプッシュがある場合:
ビルドが失敗した場合、手動で再実行できます:
各ブランチのビルド成果物は、独立したストレージ領域に保存されます。ブランチを削除すると、対応するストレージも解放されます。
プルリクエストを作成すると、そのブランチのドキュメントを自動的にプレビューできます。
プレビューURLはプルリクエストのブランチ名でアクセスできます:
https://guidebook.dev/{org}/{repository}/{pr-branch}/
main または master: 本番ドキュメントdevelop: 開発版ドキュメントfeature/*: 機能ブランチdocs/*: ドキュメント専用ブランチマージ済みのブランチは定期的に削除することを推奨します: