Doc Categories プラグイン のために廃止されています。新しいプラグインが実験的と見なされなくなるまで、Docs は引き続きサポートされます。
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 の継続として開発されました。
当社でホストされていますか？ このプラグインは、すべてのホスティングプランで利用可能です。https://www.discourse.org/plugins/docs.html
「いいね！」 95
Hyan
2023 年 9 月 25 日午前 9:52
341
こんにちは、Discourseコミュニティの皆さん、
specを実行した際に以下のエラーが発生しました。ファイルを変更していません。このエラーは無視しても良いでしょうか？
➜ discourse git:(main) ✗ LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec
Randomized with seed 57815
...................................F
Failures:
1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Failure/Error: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
expected to find css ".topic-excerpt" but there were no matches
[Screenshot Image]: /xxxx/discourse/discourse/tmp/capybara/failures_r_spec_example_groups_discourse_docs_index_topic_excerpts_when_the_theme_modifier_serialize_topic_excerpts_is_true_shows_the_excerpts_460.png
~~~~~~~ JS LOGS ~~~~~~~
~~~~~ END JS LOGS ~~~~
# ./plugins/discourse-docs/spec/system/docs_index_spec.rb:52:in `block (4 levels) in <main>'
# ./spec/rails_helper.rb:469:in `block (2 levels) in <top (required)>'
Finished in 13.16 seconds (files took 2.79 seconds to load)
36 examples, 1 failure
Failed examples:
rspec ./plugins/discourse-docs/spec/system/docs_index_spec.rb:50 # Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Randomized with seed 57815
tpetrov
2023 年 11 月 28 日午前 9:19
347
「いいね！」 1
Hyan
2023 年 11 月 29 日午後 12:49
349
申し訳ありません、@JammyDodgerさん 。最近、Specを実行する機会がありませんでした。最近はDiscourse Docs関連の仕事には集中しておらず、他のことをしています。しかし、機会があればお知らせします。
「いいね！」 2
ハンバーガーメニューの「ドキュメント」の横にあるアイコンを、リンク/チェーンから別のものに変更する方法はありますか？
このプラグインは、すべてのドキュメントカテゴリを1か所にまとめるのに最適です。これにより、カテゴリリスト（Discourse Category Hiderのおかげで）にもそれらをリストする必要がなくなります。しかし、問題に気づきました。
Docs Plugin/画面内では、既存のドキュメントを編集したり、新しいドキュメントを作成したりできません。つまり、編集したいトピック/ドキュメントを見つけるには元のカテゴリに移動する必要があり、ドキュメントを複数の場所にアクセス可能にする必要があります。
Docsプラグイン内で、トピック/ドキュメントの編集を有効にする方法はありますか（ユーザーが適切なユーザーグループにいる場合）。
Moin
2023 年 12 月 13 日午後 9:55
352
「このトピックに関するディスカッションを表示する」リンクを使用して、そのトピックに移動して編集することはできますか？
「いいね！」 1
こんにちは、非常に迷惑な問題が発生しており、その原因がわかりません。
ドキュメントを作成すると、ドキュメント領域に表示され、期待どおりに機能します。しかし、ドキュメントが編集されると、クリック時にドキュメントのリストのトピックのドキュメントレイアウトがデフォルトのDiscourseトピックレイアウトに戻り、実際のドキュメントレイアウトが表示されなくなります。
数分後にトピックドキュメントレイアウトに戻り、期待どおりに表示されることに気づきました。何か原因となっている可能性はありますか？
また、テーマコンポーネント「Topic Thumbnails」を使用しており、ドキュメントのサムネイルモードを「list」に設定していることに注意してください。
問題が見つかりました。どうやら、Topic List Excerpts または Topic lists Thumbnails というテーマコンポーネントを使用すると、クリック可能な href が KB ドキュメントの docs?topic=xxx ではなく、Discourse のトピックページのものになるため、Discourse のトピックにリダイレクトされています。
ドキュメントの URL パスを docs に維持する方法はありますか？ @sam または @david に連絡すべきでしょうか？
こんにちは。
ユーザーが最近、些細なデザイン上の問題に気づきました。ブラウザのビューポート幅が狭い場合、次のようなスクリーンショットのように、各ドキュメント投稿のコンテンツがオーバーフローします。
ビューポートが理想よりも狭い場合にサイドバーを自動的に折りたたむ方が良いのではないかと思いますが、サイドバーを折りたたんだとしても、コンテンツはオーバーフローしたままになります。
素晴らしいアドオンをありがとうございます。ただ、1つ質問があります。コンテキストハンバーガーメニューからリンクを削除するオプションはありますか？手動で常に表示されるセクションに追加しました（長文のユーザー作成コンテンツ（記事など）を紹介するためにこの機能を使用したいと考えているため）が、結果として2回表示されるようになりました。
背景が薄い両方のオプションは /docs につながります。
CSSで非表示にできると思います。
.sidebar-section-link-wrapper[data-list-item-name="docs"] {
display: none;
}
「いいね！」 1
完璧に機能しました！どうもありがとうございました！
rly
2024 年 2 月 8 日午後 5:16
359
ドキュメントページにコメントを統合し、投稿へのリンクとコメント機能の代わりにできるようにするオプションはありますか？
「いいね！」 1
同じビューポート幅のデバイスで同じリンクを再度確認しました。サイドバーを折りたたむ前はまだオーバーフローしていましたが、折りたたんだ後はオーバーフローがなく、表示は正常で見た目も良いことがわかりました。
supermathie
2024 年 4 月 26 日午後 11:50
361
Docsのデフォルトの検索順序が「関連性」ではなく「アクティビティ日付」であることに驚いています 。
関連性で検索することは可能ですか？
「いいね！」 2
thaidb
2024 年 5 月 20 日午後 5:53
362
本日、Docs カテゴリにトピックを投稿しましたが、それらのトピックは Docs ページに表示されません。Docs プラグインをオフにして、テーマを再度オンにしましたが、それらのトピックはまだ表示されません。
このプラグインは、実験的な Doc Categories プラグイン のために廃止されています。新しいプラグインが実験的と見なされなくなるまで、Docs は引き続きサポートされます。
当社でホストされていますか？
