このプラグインは、実験的な 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 テーマコンポーネント の継続です。