このプラグインは、実験的な 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 の継続として開発されました。