このプラグインは、実験的な Doc Categories プラグイン に取って代わられ、廃止されます。新しいプラグインが実験的ではなくなっても、引き続き Docs をサポートします。
 |
概要 | Discourse Docs は、ナレッジベースのトピックを検索・フィルタリングする機能を提供します |
 |
リポジトリリンク | https://github.com/discourse/discourse-docs |
 |
インストールガイド | Discourse でのプラグインのインストール方法 |
機能
Discourse Docs プラグインは、Discourse フォーラムをコミュニティ主導のナレッジベースに変換する強力なツールです。ユーザーがドキュメントを作成、更新、キュレートできる専用の Docs セクションを提供します。このプラグインには、このセクションに簡単にアクセスできる Docs ボタンがあります。コミュニティの集団知見を活用し、重要な情報を一元化して提供するための素晴らしい方法です。
要するに、Docs は定義されたカテゴリと/またはタグのセット全体で、ナレッジベーススタイルのトピックをより簡単に提示できるようにします。
タグでリストをフィルタリングし、検索バーで検索し、トピックをクリックして最初の投稿を表示します – ナレッジエクスプローラのコンテキストを離れることなく。
Discourse の他の場所からナレッジベースのトピックを見つけたいですか？新しい検索ヘルパー in:kb を使用してください。
設定
-
docs enabled設定をオンにして、プラグインを有効にします。 -
docs categoriesおよびdocs tags設定にカテゴリとタグを追加します。 -
ナビゲーションメニューで Docs リンクを見つけます。
- ナレッジへのアクセスが容易になり、利益を得ましょう！
設定
| 名前 | 説明 |
|---|---|
| docs enabled | Docs プラグインを有効にする |
| docs categories | Docs に含めるカテゴリスラッグのリスト |
| show tags by group | タググループを使用してタグを整理します。関連するタグをカテゴリ分けするためにグループを作成します。 |
| docs tag groups | グループ別にタグを表示するために使用されるタググループ |
| docs tags | Docs に含めるタグのリスト |
| docs add solved filter | 解決済みのトピックのフィルターを追加します – Discourse Solved がインストールされ、有効化されている必要があります |
| docs add to top menu | Docs ビューに移動するためのリンクをトップメニューに追加します |
| docs add search menu tip | 検索メニューのランダムなヒントに “in:docs” のヒントを追加します |
有用な組み合わせ
/docs パスのリネーム
サーバーにアクセスできる場合、app.yml に DISCOURSE_DOCS_PATH: 環境変数を追加することで、/docs リンクのパスを変更できます：
変更を有効にするには、./launcher rebuild app を実行するか、環境変数なので ./launcher destroy app && ./launcher start app を実行してダウンタイムを最小限に抑えることができます。それに関する詳細情報はここにあります - Set Environmental Variables
また、サイト表示テキストも一致するように変更したいかもしれません。/admin/customize/site_texts ページから ‘docs’ のすべてのインスタンスを検索できますが、主なものは以下の通りです：
- js.docs.title
- js.sidebar.docs_link_text
/docsパスのリネームは、エンタープライズプランでのみ利用可能です。詳しく知りたい場合は、お問い合わせください。
開発履歴
Docs プラグインは Knowledge Explorer Theme Component の続編でした。