カスタムFAQとガイドライン

:bookmark: これは、Discourse サイトのよくある質問(FAQ)ページとガイドラインページをカスタマイズするための管理者向けガイドです。

:person_raising_hand: 必要なユーザーレベル:管理者

Discourse 内の FAQ ページとガイドラインページをカスタマイズすることで、コミュニティの特定のニーズやルールに合わせてコンテンツを調整できます。これらのページは、新規ユーザーが期待される行動を理解するための最初の参照先となることが多く、既存のメンバーにとってもリソースとして機能します。

FAQ およびガイドラインページ

デフォルトでは、Discourse には FAQ ページのみが含まれています。

ただし、ガイドラインページを作成することも可能です。これにより、各ページに焦点を絞ったコンテンツを提供でき、FAQ では一般的な質問に対応し、ガイドラインではコミュニティのルールを明記できます。

サイトにガイドラインページを追加するには、管理設定の faq url にトピックの URL または外部 URL を追加する必要があります。ここでは、公開されたページ の URL を使用することもできます。

これにより、既存の「FAQ」タブ alongside に「Guidelines」ページ(.../guidelines でアクセス可能)が作成されます。

FAQ をガイドラインに名前変更(今後の変更)

Discourse では、ナビゲーション内の FAQ ページを「Guidelines」に名前変更する 今後の変更rename_faq_to_guidelines)を順次展開しています。この変更が有効化されると:

  • ナビゲーションタブに FAQ ではなく Guidelines と表示されます
  • /faq/rules/conduct はすべて /guidelines にリダイレクトされます(faq_url が設定されていない場合)
  • サイドバーのリンクが「FAQ」から「Guidelines」に変更されます
  • faq_url設定されている 場合、以前と同様に「Guidelines」と「FAQ」の両方のタブが表示されます

FAQ ページのコンテンツ自体は変更されません。ラベルとルーティングのみが変更されます。この今後の変更は、管理 → 今後の変更 ページから管理できます。

FAQ およびガイドラインのコンテンツ

Discourse の FAQ ページには、フォーラムのガイドラインやよくある質問のテンプレートとなるデフォルトのコンテンツが含まれています。このコンテンツを編集するには:

  1. フォーラム上の FAQ/Guidelines トピックに移動します。これは通常、Discourse インスタンスのセットアップ時にデフォルトで作成されます。このトピックは通常、スタッフカテゴリにピン留めされていますが、移動された場合は他のカテゴリにあります。
  2. フォーラム上の他のトピックと同様に投稿を編集します。管理者またはモデレーターとして、コミュニティのルールや期待に合わせてテキストを修正できます。
  3. 必要な変更を行った後、編集を保存して FAQ ページのコンテンツを更新します。

代わりに外部の FAQ ページにリンクしたい場合は、faq_url サイト設定を変更して、外部 FAQ ページの URL を指すように設定できます。

ガイドラインページを追加した場合、このページは FAQ/Guidelines トピックをコンテンツとして使用します。上記と同様のプロセスに従ってガイドラインページのコンテンツをカスタマイズできます。

ナビゲーションラベル名

FAQ とガイドラインのナビゲーションメニューで使用されるテキストラベルは、管理 → カスタマイズ → テキストページ(.../admin/customize/site_texts/)でカスタマイズできます。

js.guidelinesjs.faq を検索して、ナビゲーションラベルに対応するテキストコンテンツを見つけ、希望する用語に変更します。

また、サイドバーで FAQ に使用されるナビゲーションラベルは、js.sidebar.sections.community.links.faq.content を編集して更新できます。rename_faq_to_guidelines という今後の変更が有効化されている場合は、代わりに js.sidebar.sections.community.links.guidelines.content を編集します。

このプロセスの詳細については、Customize text in Discourse を参照してください。

URL ルート

サイトにガイドラインページが含まれていない場合、以下の URL スラッグから FAQ ページにアクセスできます。

  • /faq
  • /guidelines
  • /rules
  • /conduct

サイトにガイドラインページが含まれている場合、以下の URL を使用してガイドラインページにアクセスできます。

  • /guidelines
  • /rules
  • /conduct

ガイドラインページが存在する場合、FAQ ページには /faq または SiteSetting.faq_url からのみアクセスできます。

:bulb: rename_faq_to_guidelines という今後の変更が有効化され、かつ faq_url が設定されていない場合、/faq/rules/conduct はすべて /guidelines にリダイレクトされます。

:person_raising_hand: /faq/guidelines のような URL ルートを変更する方法はありますか?

いいえ。Discourse にはこれらのルートを変更するコア機能はありませんが、プラグインを使用することで可能です。

ナビゲーションラベルの非表示

サイトの構造に応じて、FAQ とガイドラインページのナビゲーションリンクを非表示にしたい場合があります。これは、サイト上で CSS を変更する ことで実現できます。

具体的には、以下の CSS を使用して FAQ とガイドラインのナビゲーションラベル名を非表示にできます。

FAQ ナビゲーションラベルの非表示

.nav-pills .nav-item-faq {
    display: none;
}

ガイドラインナビゲーションラベルの非表示

.nav-pills .nav-item-guidelines {
    display: none;
}

さらに、以下の CSS を使用してサイドバー/ハンバーガーメニューから FAQ ボタンを非表示にできます。

li[data-list-item-name="faq"]{
    display: none;
}

rename_faq_to_guidelines という今後の変更が有効化されている場合、サイドバー項目名が「guidelines」に変更されるため、以下を使用します。

li[data-list-item-name="guidelines"]{
    display: none;
}

サイドバーへのガイドラインの追加

カスタムハンバーガーメニューリンク テーマコンポーネントを使用して、ハンバーガーメニューまたはサイドバーにガイドラインページへのリンクを追加できます。このコンポーネントのインストール方法の詳細については、テーマまたはテーマコンポーネントのインストール を参照してください。

テーマコンポーネントがインストールされると、以下のエントリを使用してガイドラインページへのリンクを追加できます。

Guidelines,/guidelines,g

コミュニティ管理のヒント

Discourse 上で FAQ とガイドラインをカスタマイズすることは、コミュニティの独自のアイデンティティや文化、および空間の期待を形成する上で重要です。これはコミュニティ意識の醸成に役立つだけでなく、やるべきこととやってはいけないことの明確化にもつながり、モデレーションの負荷を大幅に軽減し、ユーザーエクスペリエンスを向上させます。

よく構成された FAQ セクションは、新規メンバーを効率的にオンボーディングするために非常に価値があり、一般的な問い合わせを事前に回答することで、より深掘りした魅力的な議論を可能にします。

これらのドキュメントは、推奨される行動を明確な例とともに強調する肯定的なトーンで作成するのが有益です。箇条書きや見出しを使用してコンテンツを簡潔かつ整理された状態に保つことも、情報の消化を助けます。

「いいね!」 9