カテゴリー
このガイドでは、GitLab における Zendesk カテゴリーを作成、編集、管理する方法について説明します。管理者は管理者タスクセクションを確認してください。
技術的な詳細
- デプロイタイプ:
Standard - 同期リポジトリ
CustSuppOps Zendesk Test Suite Generatorが有効
カテゴリーを理解する
カテゴリーとは
Zendeskによると:
カテゴリーは、ヘルプセンターの最上位の整理コンテナです。カテゴリーにはセクションが含まれます。ヘルプセンターには少なくとも 1 つのカテゴリーが必要です。ヘルプセンターにカテゴリーが 1 つしかない場合、カテゴリー自体はエンドユーザーには非表示になり、ヘルプセンターのセクションのみが表示されます。
ナレッジセンターでは、3 層構造を使用しています:
- カテゴリー(最上位) - 主要なトピック領域を整理します。このページで説明します
- セクション(中間レベル) - カテゴリーを関連するグループに細分化します。セクションページで説明します
- 記事(コンテンツレベル) - 個々のヘルプ記事です。記事ページで説明します
カテゴリーの管理方法
Zendesk は UI を通じてカテゴリーを完全に管理する方法を提供していますが、私たちはよりバージョン管理されたメソドロジーを採用しています。これにより、定められたレビュープロセス、必要に応じたロールバックの実行などが可能になります。
このため、同期リポジトリを使用しています。
現在使用中のカテゴリー
- Zendesk Global
- Zendesk US Government
非管理者としてカテゴリーを作成する
カテゴリーを作成する場合は、機能リクエスト Issueを作成してください(Customer Support Systems チームによる手動対応が必要なため)。
非管理者としてカテゴリーを編集する
カテゴリーを変更する場合は、機能リクエスト Issueを作成してください(Customer Support Systems チームによる手動対応が必要なため)。
非管理者としてカテゴリーを削除する
カテゴリーの無効化をリクエストする場合は、機能リクエスト Issueを作成してください(Customer Support Systems チームによる手動対応が必要なため)。
管理者タスク
注記
- このセクションのすべての項目には、Zendesk の
Administratorレベルのアクセス権が必要です。
Zendesk でカテゴリーを表示する
Zendesk で現在のカテゴリーを確認するには:
- Zendesk インスタンスのナレッジセンターダッシュボードに移動します
- 左側の
Arrange contentアイコンをクリックします
カテゴリーを作成する
警告
- これは、対応するリクエスト Issue(機能リクエスト、管理、バグなど)がある場合にのみ実行してください。存在しない場合は、まず作成し、作業を開始する前に標準プロセスを経る必要があります。
- SEO への影響: カテゴリーは URL 構造、検索インデックス、記事の見つけやすさに影響します。カテゴリー名または構造を変更すると、既存のリンクが切れ、検索エンジンのランキングに影響する可能性があります。
- カテゴリーを変更する場合は注意してください。
カテゴリーを作成するには、同期リポジトリで MR を作成する必要があります。正確な変更内容はリクエスト自体によって異なります。次の開始テンプレートを使用できます:
---
name: 'Your category name here'
previous_name: 'Your category name here'
description: 'Your description here'
locale: 'en-us' # This should always be used
position: 0 # Integer representing category display order
source_locale: 'en-us' # This should always be used
ピアが MR をレビューして承認した後、MR をマージできます。次回のデプロイ時に Zendesk に同期されます。
カテゴリーを編集する
警告
- これは、対応するリクエスト Issue(機能リクエスト、管理、バグなど)がある場合にのみ実行してください。存在しない場合は、まず作成し、作業を開始する前に標準プロセスを経る必要があります。
- SEO への影響: カテゴリーは URL 構造、検索インデックス、記事の見つけやすさに影響します。カテゴリー名または構造を変更すると、既存のリンクが切れ、検索エンジンのランキングに影響する可能性があります。
- カテゴリーを変更する場合は注意してください。
カテゴリーを編集するには、同期リポジトリで MR を作成する必要があります。正確な変更内容はリクエスト自体によって異なります。
ピアが MR をレビューして承認した後、MR をマージできます。次回のデプロイ時に Zendesk に同期されます。
カテゴリー名を変更する
カテゴリー名を変更する必要がある場合は、現在の値を previous_name 属性にコピーしてから、name 属性を変更します。これにより、同期は更新対象のカテゴリーを引き続き特定できます。
カテゴリーを削除する
危険
- これは、対応するリクエスト Issue(機能リクエスト、管理、バグなど)がある場合にのみ実行してください。存在しない場合は、まず作成し、作業を開始する前に標準プロセスを経る必要があります。
- カテゴリーを削除すると、そのカテゴリーに含まれるすべてのセクションも削除され、セクションに含まれるすべての記事(翻訳を含む)はアーカイブされます。
- 実行する際は細心の注意を払ってください。
同期リポジトリは削除を実行しないため、カテゴリーを削除するには 2 つのアクションを行う必要があります。
まず、同期リポジトリから対応するファイルを削除する必要があります。ピアが MR をレビューして承認した後、MR をマージできます。
その後、Zendesk 自体から削除する必要があります。
Zendesk からカテゴリーを削除するには:
- カテゴリー一覧に移動します
- 削除するカテゴリーの右側にある縦に並んだ 3 つの点をクリックします
Edit categoryをクリックします- 左側にある
Delete categoryをクリックします OKをクリックして変更を確認します
例外デプロイを実行する
カテゴリーの例外デプロイを実行するには、該当するカテゴリ―同期プロジェクトに移動し、スケジュールパイプラインページで同期項目の再生ボタンをクリックします。これにより、カテゴリーの同期ジョブがトリガーされます。
よくある問題とトラブルシューティング
マージ後にカテゴリーの変更が表示されない
カテゴリーは Standard デプロイタイプに従うため、通常のデプロイサイクル中(または例外デプロイが実行された場合)にのみデプロイされます
c955a93f)