GitHubインテグレーションを使用すると、GitHubを使ってテーマを共同で開発、管理でき、Guideでのテーマのプレビューや公開が可能になります。GitHubインテグレーションを設定する場合は、必ずテーマをGitHubに保存してから、Guideで設定をしてください。
GuideでGitHubインテグレーションを設定するには、Guideの管理者であることが必要です。
GitHubにテーマを準備する
GuideでGitHubインテグレーションを設定する前に、GitHubにテーマを準備する必要があります。GitやGitHubを初めて使用する場合は、このチュートリアルを参照してください。すでにテーマがGitHubに存在する場合は、以下の要件を満たすようにしてください。「GitHubインテグレーションを設定する」を参照してください。
GitHubインテグレーションでは、GitHubのリポジトリに関して以下の要件があります。
-
マニフェストファイルは、GitHubのリポジトリのルートに置く
Guideがテーマを追加できるよう、manifest.jsonファイルはGitHubのリポジトリのルートに置く必要があります。Guideへのインポート時に無視されるツールのような特殊なファイルも含めることが可能です。
-
GitHubのリポジトリに置くテーマは1つだけにする
各リポジトリでは、1つのテーマだけを管理するようにします。ブランチオプションを使用すると、テーマをインポートする際にさまざまなテーマを試すことができます。
GitHubのリポジトリにテーマを配置するには
- 現時点でテーマをお持ちでない場合は、Copenhagenテーマのリポジトリを使用して、テーマを作成します。これにより、将来的にCopenhagenテーマが改善された場合、作成したテーマに簡単に移植することができます。
- Guideにテーマが存在する場合は、Guideからテーマをダウンロードし、GitHubのリポジトリを作成（GitHubのリポジトリが存在しない場合）してから、そのリポジトリにテーマをプッシュします。
- GuideやGitHubにテーマが存在しない場合は、GitHubのリポジトリを作成してから（GitHubのリポジトリが存在しない場合）、そのリポジトリにテーマをプッシュします。
GitHubにテーマを用意できたら、GuideでGitHubインテグレーションを設定するする準備が整います。
GitHubインテグレーションを設定する
GitHubインテグレーションを設定するには、必ずテーマをGitHubに保存し、GitHubからテーマを取得してGuideへ移す必要があります。このように取得の作業を1回行うだけで、テーマとGitHubとの間にコネクションが確立されます。
GitHubインテグレーションを設定し、準備ができたら、GitHubでテーマに作業を行い、Guideでテーマを更新します。Guideでは、テーマのプレビューや公開をライブで処理できます。
GitHubインテグレーションでGuideテーマを設定するには
- テーマの準備が完了していることを、GitHubで確認します。
- Guideで、サイドバーにあるデザインをカスタマイズアイコン（
）をクリックします。
「テーマ」ページが開きます。
- 右上にある「テーマを追加」をクリックします。
- 「GitHubから追加」をクリックします。
- リポジトリのURLを入力します。また、デフォルトのブランチ以外から情報を取得する場合は、そのブランチの名前を入力します。入力が完了したら、「インポート」をクリックします。
- ログインを求められたらGitHubにログインし、「Authorize Zendesk」をクリックします。
インポートが完了すると、テーマのページにテーマのサムネイルが表示されます。問題が発生した場合は、「GitHubインテグレーションのGuideテーマに関する問題のトラブルシューティング」を参照してください。
GuideのテーマとGitHubの間にコネクションを確立したら、GitHubでテーマを管理し、必要に応じてGuideでテーマを更新します。