Discourse 文档

:warning: 本插件即将停用,推荐使用实验性的 Doc Categories 插件。在新插件不再被视为实验性之前,我们仍将继续支持 Docs。

:discourse2: 摘要 Discourse Docs 提供了查找和筛选知识库主题的功能
:hammer_and_wrench: 仓库链接 https://github.com/discourse/discourse-docs
:open_book: 安装指南 如何在 Discourse 中安装插件

功能

Discourse Docs 插件是一个强大的工具,它将你的 Discourse 论坛转变为由社区驱动的知识库。它提供了一个专门的 Docs 部分,用户可以在其中创建、更新和管理文档。该插件包含一个 Docs 按钮,方便用户访问该部分。这是利用社区集体智慧并为重要信息提供集中资源的好方法。

本质上,Docs 允许在定义的一组类别和/或标签中更轻松地展示知识库类型的主题。

通过标签筛选列表,通过搜索栏进行搜索,并点击主题查看第一篇文章——所有这些操作都不必离开知识探索器的上下文。

需要查找 Discourse 其他位置的知识库主题吗?使用新的搜索辅助命令:in:kb

配置

  1. 通过开启 docs enabled 设置来启用插件。

  2. 将类别和标签添加到 docs categoriesdocs tags 设置中。

  3. 在导航菜单中找到 Docs 链接。

  1. 轻松获取知识,获益匪浅!

设置

名称 描述
docs enabled 启用 Docs 插件
docs categories 包含在 docs 中的类别 slugs 列表
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

:discourse2: 由我们托管? 重命名 /docs 路径仅在我们的企业计划中可用。如需了解更多,请联系我们。

开发历史

Docs 插件是 Knowledge Explorer 主题组件 的延续。


:discourse2: 由我们托管? 该插件在我们所有的托管计划中均可用。 https://www.discourse.org/plugins/docs.html

95 个赞
Discourse Doc Categories
Using Posts as a Wiki?
Using Discourse as a internal Knowledge Base / Intranet
Is anyone working on a Discourse Wiki?
Documentation Library
Community glossary?
The Docs button on meta.discourse
Memberful opinions?
Filtering by multiple tags
Subcategories and tag groups layout
Discourse Docs + Pavilion Layouts Plugin
[Paid] Parent/Child Tagging System + Docs Plugin Group Tagging
Docs page in Discourse
Mirrored topic: same topic in two categories
Published page not visible?
Nest subcategories under their parent categories in the sidebar
File/Document Repository?
Creating user guides for your community
Allow plugins (like docs) to add top-level links in sidebar (rather than hide them in More...)
FAQs, less thread-y more article-y
Email list server?
Recommnded plugins for supporting a tech community run by a big enterprise?
Is it possible to display the thumbnails in Docs?
Customize docs plugin text link
Install discourse doc plugin from Git is failed
Advice on a support forum
Knowledge Base
Knowledge Base
Grow my community
Published topic with a link to itself in the forum?
Topic List Thumbnails don't play well with Docs
How-to use Discourse for managing a collaborative newsletter?
Is it possible to restrict certain “docs” to appear based on the user’s groups?
Pinning a post to the top of the topic
Knowledge Base
Discourse has slowly been solving a fatigue I didn't realize I had
Documentation in a Discussion forum
Discourse docs search error, 500 error
Discourse docs search error, 500 error
Discourse Docs Plugin – Topics Not Updating in Docs Page
Forum not working after update – what’s missing?
What is this component?
Making my discourse site look a certain way
Time tracking using Discourse?
Back button behavior on docs
Topic List Previews (TLP)
Workspace Views
New documentation plugin in development
Discourse Category Lockdown
Is anyone here using their Discourse instance as their entire website?
Question Answer Plugin
How to make the recommanded topics collection
New homes for official and community documentation
Is it possible to show tags in place of subcategories?
Disable auto-scroll for certain topics?
Implementing KCS
How can I compare arbitrary revisions of a post?
How to create a page like the official Discourse docs?
Option to use "Docs view" when accessing Docs category from anywhere in Discourse
DiscoTOC - automatic table of contents
When a thread is too important to lose
About this Community and the Docs
Ability to Create Private Templates
Tips into building a community aside a variety of already existing tools
Sidebar for Subcategories