Discourse-docs: Documentation Management Plugin

[justin (Justin DiRose)]

Summary: Find and filter knowledge base topics

GitHub: https://github.com/discourse/discourse-docs
Install: Follow the plugin installation guide.

Features

The Docs plugin is a continuation of development on the Knowledge Explorer Theme Component. You can see it in action at https://meta.discourse.org/docs.

In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.

Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.

Need to find a knowledge base topic from somewhere else in Discourse? Use the new search helper: in:kb.

Configuration

1. Install the plugin following these instructions.
2. Enable the plugin by turning on the docs enabled setting.
3. Add categories and tags to the docs categories and docs tags settings.
4. Find the Docs link in the hamburger menu.
   
5. Profit with easier access to knowledge!

Helpful Pairings

Discourse Docs Card Filter Component

This theme component is to be used with the Discourse Docs Plugin. It will allow you to place “Cards” that act as a clickable filter for quicker filter results upon entering the /docs page by your users. [image] The above would be rendered with these settings in the docs plugin: [image] Component Settings You can select custom icons for each category or tag card filter. You can also allow category descriptions to be rendered in the category card filters. [image] …

CHANGELOG

• 2021-01-18T06:00:00Z Rename to discourse-docs
• 2021-01-13T06:00:00Z Add topic title and category to browser title
• 2020-10-01T05:00:00Z Added onebox support

TODO

[Saif-Shines]

Is it possible to change the slug from /docs to /wiki?

[huynhthai824 (Sora &\)]

Hello Justin DiRose,
Can we display categories docs with structure format?

[justin (Justin DiRose)]

I don’t believe subcategory structure is currently available for the filtering component.

[LKinora]

Hi @justin -
Do categories and topics adjust to user group?
So if a user is from group A, they only see categories and topics that group A has permissions to?

Do the card filter components, seen at the top of the page of the Discourse Meta Docs, also adjust to group permissions?

Thank you so much in advance for your answers.
Lisa

[justin (Justin DiRose)]

@LKinora

Do categories and topics adjust to user group?
So if a user is from group A, they only see categories and topics that group A has permissions to?

Yes this is correct.

@LKinora

Do the card filter components, seen at the top of the page of the Discourse Meta Docs, also adjust to group permissions?

I’m not aware actually, but I’d guess yes.

[MarcBria]

Thanks for the great plugin. Looks great.

Is this module compatible with the voting plugin?
In other words: Could DOCS be voted as regular posts?

Thanks for your time,
M.