テーマ

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

テーマを理解する

テーマとは

テーマとは、サポートポータルの外観を決定する一連のファイルです。

私たちのテーマの管理方法

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

そのため、私たちは同期リポジトリを利用しています。

管理者以外の立場でテーマを作成する

テーマの作成については、Feature Request issue を作成してください（Customer Support Operations チームによる手動対応が必要なため）。

管理者以外の立場でテーマを編集する

テーマの変更については、Feature Request issue を作成してください（Customer Support Operations チームによる手動対応が必要なため）。

管理者以外の立場でライブテーマを変更する

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

管理者以外の立場でテーマを削除する

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

管理者タスク

Zendesk のテーマを表示する

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

1. ナレッジセンターにアクセスします
2. 左側の Customize design アイコンをクリックします:
   • プライマリブランドの場合:
     • Zendesk Global (production)
     • Zendesk Global (sandbox)
     • Zendesk US Government (production)
     • Zendesk US Government (sandbox)
   • 内部ブランドの場合:
     • Zendesk Global (production)
     • Zendesk Global (sandbox)
     • Zendesk US Government (production)
     • Zendesk US Government (sandbox)

テーマを作成する

これは、私たちのシステムに統合する非常に複雑なプロセスです。そのため、これについては Customer Support Operations チームのフルスタックエンジニアにサポートを依頼してください。これは非常に手作業のプロセスです。

テーマを編集する

テーマを編集するには、同期リポジトリで MR を作成する必要があります。具体的な変更内容は、依頼自体に依存しますが、変更時には必ずバージョニング情報を使用してください。

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

ピアによるレビューと承認の後、MR をマージできます。

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

次のデプロイメントが行われる際に、Zendesk に同期されます。

バージョニング情報

テーマで正しいバージョニングスタイルを使用することは不可欠です。バージョン自体は data/theme/manifest.json ファイルの version 属性に由来します。これはピリオドで区切られた 3 桁を使用します。変更を行う際には、これらの桁の意味を念頭に置いてください:

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

Example 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",

Example 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 Operations チームのフルスタックエンジニアにサポートを依頼してください。これは非常に手作業のプロセスです。

テーマを削除する

ライブではないテーマを削除する場合は、通常通り進めることができます。これを行うには:

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

例外デプロイメントを実行する

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

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

マージ後にテーマの変更が反映されない

テーマは Standard デプロイメントタイプに従うため、通常のデプロイメントサイクル（または例外デプロイメントが行われたとき）にのみデプロイされます。

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