| Suite | Growth、Professional、EnterpriseまたはEnterprise Plus |
| Support | + Guide ProfessionalまたはEnterprise |
）>「テーマを追加」>「GitHubから追加」GitHubインテグレーションを使用すると、GitHubを使ってテーマを共同で開発、管理でき、Guideでのテーマのプレビューや公開が可能になります。GitHubインテグレーションを設定する場合は、必ずテーマをGitHubに保存してから、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で確認します。
-
ナレッジベース管理者で、サイドバーにあるデザインのカスタマイズ（）をクリックします。
「テーマ」ページが開きます。
- 右上にある「テーマを追加」をクリックします。
- 「GitHubから追加」をクリックします。
- リポジトリのURLを入力します。また、デフォルトのブランチ以外から情報を取得する場合は、そのブランチの名前を入力します。入力が完了したら、「インポート」をクリックします。
- ログインを求められたらGitHubにログインし、「Authorize Zendesk」をクリックします。
インポートが完了すると、テーマのページにテーマのサムネイルが表示されます。問題が発生した場合は、「GitHubインテグレーションのGuideテーマに関する問題のトラブルシューティング」を参照してください。
GuideのテーマとGitHubの間にコネクションを確立したら、GitHubでテーマを管理し、必要に応じてGuideでテーマを更新します。
16件のコメント
Adam Jakab
Hi,
I am confused about the authorization request.
I add the target repo so that ZD can pull the updated repo content from GH.
Why am I being asked to authorize ZD Guide app for full read/write permissions on all private and public repositories?
I had to decline. Can you review this?
0
Chris Batt
It's been 18 months since the last ask to sync with GitLab, so I'll add my +1. Rather than hooking up a custom integration, I would love to see it natively supported.
0
Gorka Cardona-Lauridsen
Adeem Basraa A Gitlab integration is not on the roadmap currently, but you could set up your own integration using the Themes API.
0
Adeem Basraa
Is there a possibility to sync with GitLab instead of GitHub? I know it snot possible currently but is the integration with gitlab in the roadmap?
1
Nara
0
Simon
Hi Clifford James Lacson ,
In regards to managing change conflicts, we plan to copy the Zendesk Copenhagen theme repo rather than fork it, that way we can create our own forks privately. From there, we can pull updates from the main repo and marge them with our private fork. Github helps manage change conflict but we wanted to know how Zendesk might help prevent conflicts when updating the theme files?
0
Clifford James Lacson
Thanks for reaching out to us! My name is Clifford from the Advocacy department and I'll be the one assisting you with your concern. :)
In regard to your concern with Github Enterprise Cloud, I have reached out internally to our Github team so I will be providing you an update once I confirmed with them.
For the 2nd one, may you please elaborate on managing change conflicts? Can you provide a use case for this?
I look forward to your response!
0
Simon
1
Greg Katechis
0
Brandon Castillo
Hi Zendesk,
Is it possible to add a private repo to the GH integration? If not, are there any updates on future integrations like BitBucket? I couldn't find any help articles related to those topics. Thank you.
0
サインインしてコメントを残してください。