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