Discourseのドキュメントカテゴリ

ここに外部リンクを使用できますか?また、新しいタブで開くために _blank を使用しますか?

オプションで、カテゴリの簡単な説明から始めることができます。

## 外部テスト
* Google: https://google.com

## 最初のセクション
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* 短いタイトル: https://discourse.example.com/t/topic-with-a-long-title/56
* 別のタイトル: https://discourse.example.com/t/another-topic-with-a-long-title/78

## 2番目のセクション
* トピックタイトル: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
「いいね!」 1

サポートされていないインストールには、通常、サポートされていないインストールのリンクが表示されます。免責事項として、問題の一部が関連している可能性があるためです。

プラグイン、テーマ、およびテーマコンポーネントには、通常、バージョン互換性に関するファイルがあります。

以下を参照してください。

このファイルを開くと、重要なバージョン互換性のメモが表示されます。他のファイルでは、説明内に記載されている場合があります。たとえば、Category Moderatorsプラグインには、安定版のみをサポートするという免責事項があります。

Pavilionは、アドオンを更新する時間を確保するために、推奨されるDiscourseの更新頻度を提供しています。

「いいね!」 2

これはサブカテゴリにも適用されますか? 6つのコアカテゴリを持つサイトがありますが、各カテゴリのドキュメントとディスカッションが必要です。これを達成する最善の方法がよくわかりません。

はい、表示されます。こちらで#documentationで確認できます。メインカテゴリは基本的にサブカテゴリの目次です。

「いいね!」 3

これを見つけたのですが、いくつか質問があります。クラウドホストサイトにインストールするにはどうすればよいですか?また、古いドキュメントはあとどれくらい利用可能だと思いますか?

「いいね!」 1

古いプラグインを完全に削除する時期はまだ決まっていませんが、現在積極的に開発は行われていません。決定事項ができ次第、皆様にお知らせいたします!

このプラグインはまだ#experimentalであるため、当社のホスティングでは利用できませんが、現在社内で検討しており、このプラグインを利用可能にできるか確認中です。結論が出次第、こちらでご報告いたします。

「いいね!」 5

混乱している他の人のために、このプラグインが実際に行うことを追加します。

すべての設定やインデックストピックなどがあるため、何ができるか、どのように使用できるかを理解しようとすることに加えて、圧倒される可能性があります。少なくとも、理解する方法を見つけるまで少し混乱していました(何か見落としている場合は、遠慮なく共有してください)。

基本的に、私が理解している方法は次のとおりです。カテゴリを好きなように作成し、このプラグインはデフォルトのサイドバー(カテゴリ、タグなどのセクション)を削除し、セクションのリストと、それらのセクション内のトピック、カテゴリ、外部リンクなどへのリンクに置き換えます。私にとっては、そのように見る方が簡単です。特定のカテゴリが訪問されたときにサイドバーをカスタマイズすることに重点を置いています。たとえば、カテゴリAが訪問されたときに、デフォルトのサイドバーをインデックストピックによって提供されるカスタムサイドバーに置き換えます。シンプルです。

「いいね!」 5

9件の投稿が新しいトピックに分割されました:Discourse Docs Plugin – Topics Not Updating in Docs Page

モバイルで Docs のサイドバインデックスをより見やすくするにはどうすればよいかと思います。なぜなら、ユーザーはハンバーガーアイコンを押すまでトピックに気付かないからです。

デスクトップでは素晴らしいですが、残念ながら大半のユーザーはスマートフォンを使っています。

「いいね!」 1

選択肢はあまり多くない、というか全くないと言ってもいいかもしれません。モバイルには十分なスペースがありません。

それが、私がドキュメントを完全に削除することを検討している理由の1つです。私のユーザーの約95%はモバイルを使用しており、サイドバーをほとんど、あるいは全く使用しません。そのため、ドキュメントメニューのキュレーションは非常に時間がかかり、時間対効果のバランスが取れていないと思います😏

「いいね!」 1

ハンバーガーアイコンを左(デスクトップのように)に移動させると、ユーザーエクスペリエンスが少し向上すると思います。

ドキュメントは非常に強力ですが、無効にしたくはありません。しかし、インデックスが非表示になっているため、ユーザーにはほとんど使用されていません(!)。

「いいね!」 2

この Theme component は興味深いかもしれません

承知しました。この議論全体を読みましたが、いくつか質問があります。このページの構造がこのページによって作成されていることは理解していますが、各サブカテゴリにもインデックスページが必要なのですか?このページのインデックスは、非常に多くの記事があるため、膨大なものになるはずです…他のページも同様です。

ドキュメントサイトのページにxwikiスタイルのレイアウトを実装するのは、どれくらい難しいでしょうか。UIは非常にシンプルで、ページ作成時にこのページはドキュメントであるというチェックボックスをオンにするだけです。次に、親ページを尋ねられます。親ページがなければ、トップレベルのトピックになります。親を設定すると、そのトピック/カテゴリの下にページが表示されます。これにより、インデックスページを手動で維持する必要がなくなります。これは、余分な作業が多く、必要ないはずです。また、作成時に項目を追加し忘れる可能性もあります。

https://checkin.technospider.com にアクセスしてサイドバーの項目をいくつか展開すると、ネストが実際の例でどのように機能するかを確認できます。サイドバー全体は、ページを他のページの下にネストする(親/子関係)だけで動的に生成されます。このサイトには約150ページしかありませんが、すべてを作成するためにインデックスを作成する必要があった場合、2倍の時間がかかったでしょう。

そして、それはDocsサイドバーのレイアウトに関するUI/UXの問題につながります。メインページからクリックすると、最初のカテゴリリストが失われます。ページ上のどこかに戻る方法が必要です。
8つの主要な領域それぞれに開閉三角があり、メインページでボックスをクリックしても、サイドバーで名前をクリックしても、ドロップダウンするだけで、他の主要な領域を直接クリックする能力を失うことはありません。
各エンド記事にはパンくずリストがありますが、それさえも8つのカテゴリにはありません。ページ上部のサブカテゴリから「フィルターをクリア」をクリックすると戻りますが、これは非常に直感的ではありません。「サブカテゴリなし」をクリックすると、緑色の素敵なバナーが消えるなど、フィルターを操作することで奇妙なこともできます。

「いいね!」 3

はい、それはサイト管理トピック用です。インデックスページはこちらです。index はすべてのインデックスページを表示するタグです)

すべてのページリンクをまとめて、ラベル付きでカテゴリにきれいに配置するには、かなりの作業が必要だったことに同意します。しかし、その結果は非常に素晴らしく、使いやすいです!

「いいね!」 2

確かに見栄えは良いですが、述べたように、ナビゲーションに関しては使いやすさに問題があります。
そして、作業をなくすことができるなら、それはすべての人にとって勝利のように思えます。

私は行われた作業をけなしているわけではありません。見た目は非常に良く、コーディングができない私には、どれだけの作業が行われたのか、あるいは私の提案がどれだけ多くの作業になるのかさえ理解できません。

最低限のドキュメントとしては良いですが、リンクしたWikiで使用したマークアップの多くが欠けています。私が見落としているだけかもしれませんが。私はまだDiscourseにはかなり慣れていません。

例えば、情報/警告/エラーボックスを作成する方法が見つかりません。

ここではMetaで、引用ブロックと絵文字が使用されています。
この#theme-componentは、代替スタイルを提供しており、あなたのニーズに合うかもしれません。

「いいね!」 3

ありがとうございます。手動インデックス作成が不要になったら、役立ちそうです。

Discourse Doc Categories プラグインでサイドバー検索を復活させる /t/bring-back-sidebar-search-in-discourse-doc-categories-plugin/373883) の新しいトピックに 7 件の投稿が分割されました

投稿が既存のトピックにマージされました:サイドバーサポート「Discourseアイコン」とその他を追加

:loudspeaker: セルフホスティングユーザー向けのアップデート

このプラグインを使用しているセルフホスティングユーザーの場合、最新のアップデートではインデックスの手動再構築が必要になります。これには、次の Rake タスクを実行する必要があります。

bundle exec rake doc_categories:build_sidebar

# 上記のタスクが NoDatabaseError により失敗した場合、
# 通常のセルフホスト環境では次を実行してください
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar

この Rake タスクを実行できない場合は、各ドキュメントカテゴリの設定に移動し、カテゴリインデックスを削除して保存し、再度追加して保存してください。これにより、インデックスが再構築され、カテゴリキャッシュも更新されます。


なぜこれを行うのか?

以前は、サイドバーを生成する必要がある場合、各インデックストピックをオンザフライで解析し、キャッシュしていました。このアップデートでは、既存のインデックスをトピックではなくデータベースでバックアップするように移行します。これにより、インデックスの整理方法を改善する際の選択肢がチームに増えます。

「いいね!」 9