テーマ

このガイドでは、GitLab で Zendesk テーマを作成、編集、管理する方法について説明します。管理者は管理者タスクセクションを確認してください。

テーマについて

テーマとは

テーマは、サポートポータルの見た目を決定するファイルのセットです。

テーマの管理方法

Zendesk は UI からテーマを完全に管理する方法を提供していますが、私たちはよりバージョン管理された手法を採用しています。これにより、定められたレビュープロセス、必要に応じたロールバック機能などを実現できます。

そのため、同期リポジトリを使用します。

非管理者としてテーマを作成する

テーマを作成する場合は、Feature Request issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

非管理者としてテーマを編集する

テーマを変更する場合は、Feature Request issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

非管理者としてライブテーマを変更する

ライブテーマを変更するには、Feature Request issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

非管理者としてテーマを削除する

テーマの削除を依頼するには、Feature Request issueを作成してください（Customer Support Systems チームによる手動介入が必要になるためです）。

管理者タスク

Zendesk でテーマを表示する

Zendesk でテーマを表示するには:

1. ナレッジセンターにアクセスする
2. 左側にある Customize design アイコンをクリックします:
   • プライマリブランドの場合:
     • Zendesk Global（本番環境）
     • Zendesk Global（サンドボックス）
     • Zendesk US Government（本番環境）
     • Zendesk US Government（サンドボックス）
   • 内部ブランドの場合:
     • Zendesk Global（本番環境）
     • Zendesk Global（サンドボックス）
     • Zendesk US Government（本番環境）
     • Zendesk US Government（サンドボックス）

テーマを作成する

これはシステムに統合するには非常に複雑なプロセスです。そのため、Customer Support Systems チームの Fullstack Engineer に支援を依頼してください。非常に手作業の多いプロセスです。

テーマを編集する

テーマを編集するには、同期リポジトリに MR を作成する必要があります。具体的な変更はリクエスト自体によって異なりますが、変更には必ずバージョン管理情報を使用してください。

MR が作成されると、MR のコメントにプレビューリンクが生成されます。このリンクにより、マージ前にテーマの変更をプレビューできます。MR に新しいコミットをプッシュすると、新しいプレビューリンクが生成されます。

同僚が MR をレビューして承認した後、MR をマージできます。

マージされると、生成されたプレビューテーマ（プレビューリンク用）はシステムから自動化により削除されます。これが完了すると、デフォルトブランチに完全にマージされます。

次回のデプロイが行われると、Zendesk に同期されます。

バージョン管理情報

テーマには正しいバージョン管理形式を使用することが非常に重要です。バージョン自体は、data/theme/manifest.json ファイルの version 属性に由来します。ピリオドで区切られた 3 桁の数字を使用します。変更する際は、これらの数字の意味を念頭に置いてください:

• 1 桁目: 常に api_version 属性と一致する必要があります
• 2 桁目: 新しい MR を作成する際は、前の値に 1 を加算します
• 3 桁目:
  • 新しい MR を作成する際は、0 にします（例 1を参照）
  • 作成後に MR に新しい変更をプッシュする場合は、1 を加算します（例 2を参照）

例 1

テーマに変更を加える必要があるため、変更を開発してから新しい MR を作成します。変更を加える前の data/theme/manifest.json ファイルには次が含まれていました:

{
  "name": "GitLab Zendesk Global Theme",
  "author": "Jason Colyer",
  "version": "4.0.39",
  "api_version": 4,
  "default_locale": "en-us",

新しい MR を作成するため、新しい値は次のようになります:

{
  "name": "GitLab Zendesk Global Theme",
  "author": "Jason Colyer",
  "version": "4.1.0",
  "api_version": 4,
  "default_locale": "en-us",

作成後に MR に新しい変更をプッシュする必要がある場合、新しい値は次のようになります:

{
  "name": "GitLab Zendesk Global Theme",
  "author": "Jason Colyer",
  "version": "4.1.1",
  "api_version": 4,
  "default_locale": "en-us",

例 2

テーマ変更のために、既存の MR で同僚と作業しています。開発後、既存の MR に変更をプッシュすることにします。変更を加える前の data/theme/manifest.json ファイルには次が含まれていました:

{
  "name": "GitLab Zendesk US Government Theme",
  "author": "Jason Colyer",
  "version": "4.10.9",
  "api_version": 4,
  "default_locale": "en-us",

MR はすでに存在し、新しい変更をプッシュするため、新しい値は次のようになります:

{
  "name": "GitLab Zendesk US Government Theme",
  "author": "Jason Colyer",
  "version": "4.10.10",
  "api_version": 4,
  "default_locale": "en-us",

ライブテーマを変更する

これはシステムに統合するには非常に複雑なプロセスです。そのため、Customer Support Systems チームの Fullstack Engineer に支援を依頼してください。非常に手作業の多いプロセスです。

テーマを削除する

ライブではないテーマを削除する場合は、通常どおり進められます。実施するには:

1. テーマ一覧に移動する
2. 対象のテーマを見つけ、その右側にある縦に並んだ 3 つの点をクリックします
3. Delete をクリックします
4. 削除を確認するために Delete theme をクリックします

例外デプロイを実行する

テーマの例外デプロイを実行するには、対象のテーマ同期プロジェクトに移動し、スケジュール済みパイプラインページを開いて、同期項目の再生ボタンをクリックします。これにより、テーマの同期ジョブがトリガーされます。

よくある問題とトラブルシューティング

マージ後にテーマの変更が表示されない

テーマは Standard デプロイタイプに従うため、通常のデプロイサイクル中（または例外デプロイが実行された場合）にのみデプロイされます

ページのソースコードを見る - ページの編集 - please contribute.