Salesforce開発リポジトリのGitHub Pages設定についてです。リポジトリ内にdocsフォルダを用意すると、開発に必要なドキュメントをまとめて管理できて便利です。

ただ、メニューバーなどが表示されてこれだけだと見づらいです。GitHub Pagesを有効化してドキュメントを参照できるようにすると使い勝手が良くなります。

表示例です。

リンクをクリックして次のページに切り替えた時の内容です。

注意点としては公開先です。個人リポジトリなど、インターネットへの公開を前提とした用途ではそのまま利用できます。一方、業務用リポジトリでは公開範囲に注意が必要です。
- GitHub Enterprise Cloudを利用
- Organization所有のPrivateリポジトリ
- PagesのVisibilityをPrivateに設定
- 閲覧対象者とリポジトリのRead権限者が同じ
- 用途は設計書、仕様書、開発手順などの静的なDocs
- 機密値や個人情報は掲載しない
設定方法
1. Organizationオーナー側の利用許可
- Organizationオーナーが次の画面を開きます。
- Organization → Settings → Access → Member privileges → Pages creation
ここで許可する公開範囲を選択します。
今回の用途では、次の設定が安全です。
- Private Pages:許可
- Public Pages:不許可
これにより、Organization内のメンバーがPrivate Pagesを作成できるようになります。
この設定はOrganization全体への利用許可で、特定リポジトリだけを選択する設定ではありません。
OrganizationのPages公開設定
2. リポジトリ側のPages設定
上記の設定ができたらリポジトリ側でGitHub Pagesの設定を行います。
Pagesを利用したいリポジトリごとに、管理権限を持つユーザーが設定します。
Repository → Settings → Code and automation → Pages
今回の構成なら、次のように設定します。
- Source:Deploy from a branch
- Branch:main
- Folder:/docs
- Visibility:Private
この設定を行ったリポジトリだけにPagesサイトが作成されます。
Private Pagesは、そのリポジトリにRead権限を持つユーザーだけが閲覧できます。
その他の考慮点

設定画面
GitHub Pagesの設定画面です。

ブラウザの翻訳機能で日本語表示した例。

GitHub Pagesのスタイルの設定
_config.ymlファイルを用意してJekyllテーマを適用すると見やすい形に指定できます。
docs/ ├── _config.yml ├── index.md └── その他のMarkdownファイル
内容の例です。urlとbaseurlはPublic PagesとPrivate Pagesで設定が異なるため、共通例では省略しています。

title: Salesforce DX Project description: Salesforce DX / Apex / Salesforce metadata の学習用ドキュメント theme: jekyll-theme-primer
GitHub Pagesを有効化し、既存のdocs/index.mdに加えてdocs/_config.ymlを用意すると、指定したJekyllテーマが適用されます。GitHub上で公開するだけなら、追加のソフトウェアをインストールする必要はありません。
GitHub Pagesを有効化したドキュメントページ作成についてはこのような感じです。

























































































