セクション
このガイドでは、GitLab における Zendesk セクションの作成、編集、管理方法について説明します。管理者は管理者タスクセクションを確認してください。
技術的な詳細
- デプロイメントタイプ:
Standard - 同期リポジトリ
CustSuppOps Zendesk Test Suite Generatorを有効化
セクションを理解する
セクションとは
Zendesk によると:
セクションには関連する記事が含まれます。
要するに、カテゴリを関連するグループに細分化するために使用される項目です。
ナレッジセンターは 3 階層構造を使用します:
- カテゴリ(最上位レベル) - 主要なトピック領域を整理。カテゴリページに文書化
- セクション(中間レベル) - カテゴリを関連するグループに細分化。本ページに文書化
- 記事(コンテンツレベル) - 個別のヘルプ記事。記事ページに文書化
私たちのセクションの管理方法
現在、すべてのセクションは Zendesk 内で管理しています。
注: 同期リポジトリ経由でのセクション管理(カテゴリと同様)は、FY27 での将来の実装が計画されています。
現在使用中のセクション
- Zendesk Global
- About GitLab Support カテゴリの下:
- Knowledge articles カテゴリの下:
- Zendesk US Government
管理者以外の立場でセクションを作成する
セクションの作成については、Feature Request issue を作成してください(Customer Support Operations チームによる手動対応が必要なため)。
管理者以外の立場でセクションを編集する
セクションの変更については、Feature Request issue を作成してください(Customer Support Operations チームによる手動対応が必要なため)。
管理者以外の立場でセクションを削除する
セクションの非アクティブ化を依頼するには、Feature Request issue を作成してください(Customer Support Operations チームによる手動対応が必要なため)。
管理者タスク
注意
- このセクションのすべての項目には、Zendesk への
Administratorレベルのアクセスが必要です。
Zendesk のセクションを表示する
Zendesk で現在のセクションを表示するには:
- Zendesk インスタンスのナレッジセンターダッシュボードに移動します
- 左側の
Arrange contentアイコンをクリックします - セクションが含まれるカテゴリの名前をクリックします
セクションを作成する
警告
- これは、対応する Issue(Feature Request、Administrative、Bug 等)がある場合にのみ実施してください。存在しない場合は、まず 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 をマージできます。次のデプロイメントが行われる際に、Zendesk に同期されます。
セクションを編集する
警告
- これは、対応する Issue(Feature Request、Administrative、Bug 等)がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し(標準プロセスに従って処理されるのを待ってから)作業してください。
- SEO への影響: セクションは URL 構造、検索インデックス、記事の発見可能性に影響します。セクション名や構造を変更すると、既存のリンクが壊れたり、検索エンジンのランキングに影響を与える可能性があります。
- セクションに変更を加える場合は注意してください。
セクションを編集するには、同期リポジトリで MR を作成する必要があります。具体的な変更内容は、依頼自体に依存します。
ピアによるレビューと承認の後、MR をマージできます。次のデプロイメントが行われる際に、Zendesk に同期されます。
セクションの名前を変更する
セクションの名前を変更する必要がある場合は、現在の値を previous_name 属性にコピーしてから name 属性を変更します。これにより、同期処理が対象のセクションを引き続き特定して更新できます。
セクションを新しい場所に移動する
警告
- これは、対応する Issue(Feature Request、Administrative、Bug 等)がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し(標準プロセスに従って処理されるのを待ってから)作業してください。
- SEO への影響: セクションは URL 構造、検索インデックス、記事の発見可能性に影響します。セクションの場所や構造を変更すると、既存のリンクが壊れたり、検索エンジンのランキングに影響を与える可能性があります。
- セクションに変更を加える場合は注意してください。
セクションを新しいカテゴリに移動するには、同期リポジトリで MR を作成する必要があります。変更は単純に、ファイルを現在のフォルダ(つまり現在のカテゴリ)から新しいフォルダ(つまり新しいカテゴリ)に移動するだけです。
ピアによるレビューと承認の後、MR をマージできます。次のデプロイメントが行われる際に、Zendesk に同期されます。
セクションを削除する
危険
- これは、対応する Issue(Feature Request、Administrative、Bug 等)がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し(標準プロセスに従って処理されるのを待ってから)作業してください。
- セクションを削除すると、そのセクションに含まれるすべての記事(任意の翻訳を含む)がアーカイブされます。
- これを行う際には細心の注意を払ってください。
同期リポジトリは削除を実行しないため、セクションを削除するには 2 つのアクションを実行する必要があります。
まず、同期リポジトリから対応するファイルを削除する必要があります。ピアによるレビューと承認の後、MR をマージできます。
それが完了したら、次に Zendesk 自体から削除する必要があります。
Zendesk からセクションを削除するには:
- セクションビューに移動します
- 対象のセクションの右側にある縦に並んだ 3 つの点をクリックします
Edit sectionをクリックします- ページ左側の
Delete sectionをクリックします OKをクリックして変更を確認します
例外デプロイメントを実行する
セクションの例外デプロイメントを実行するには、対象のセクション同期プロジェクトに移動し、スケジュールパイプラインのページに移動して、同期項目の再生ボタンをクリックします。これにより、セクションの同期ジョブがトリガーされます。
よくある問題とトラブルシューティング
マージ後にセクションの変更が反映されない
セクションは Standard デプロイメントタイプに従うため、通常のデプロイメントサイクル(または例外デプロイメントが行われたとき)にのみデプロイされます。
bfd74782)