カスタムドキュメントリポジトリを作成する

新しいカスタムドキュメントリポジトリをセットアップするには、主に 2 つのステップがあります。

• 新しいカスタムドキュメントリポジトリを作成する
• カスタムドキュメントリポジトリを許可リストに追加する

新しいカスタムドキュメントリポジトリを作成する

カスタムドキュメントは Code Repositories アプリケーションから作成および公開できます。まず、Documentation テンプレートを使用してリポジトリを作成する必要があります。

ドキュメントリポジトリを保存したい場所で、New を選択し、Code repository を選びます。その後、Find and select repository type 検索バーまたは Building something else? ウィザードを使用して、新しい Documentation タイプのコードリポジトリを初期化します。

ドキュメントリポジトリの名前と場所を指定することができます。ドキュメントリポジトリは Compass リソースであるため、リポジトリを保存する場所がユーザーのドキュメントへのアクセスを決定することに注意してください。

カスタムドキュメントリポジトリを許可リストに追加する

カスタムドキュメントリポジトリを公開可能にするには、リポジトリを許可リストに追加して、ドキュメントサービスがドキュメントを検出および公開できるようにする必要があります。ドキュメントリポジトリを公開するために許可リストに追加するには、Control Panel > サポート > カスタムドキュメント に移動し、ユーザーのリポジトリに対して Configure which code repositories can publish documentation 設定をオンにします。以下のスクリーンショットは「Documentation Example」がControl Panelで許可リストに追加されていないデフォルト設定を示しています。

新しいドキュメントリポジトリを作成したばかりの場合、最初のコミットは PERMISSION_DENIED エラーでチェックに失敗することに注意してください。これは、作成後にチェックが自動的に実行され、リポジトリが許可リストに追加されなければチェックが通らないためです。しかし、リポジトリは作成される前に許可リストに追加することはできません。許可リストに追加された後、チェックを再トリガーするとドキュメントが正常に公開されます。