hugh
(Hugh Lashbrooke)
1
Discourse 文档是管理员、版主、用户和系统管理员查找使用 Discourse 和管理站点帮助的主要场所。
虽然这些文档内容丰富且覆盖面广泛，但仍有一些领域尚未记录。这是社区参与并帮助完善 Discourse 项目这一重要部分的绝佳机会。
我们非常希望看到更多人参与为 Discourse 创建文档内容，并致力于让任何人都能轻松做到这一点。为此，下面列出了一些我们确定为需要新建或改进文档的 Discourse 功能或使用场景。
文档位置
信任等级为 2 级或以上的任何人都可以在 Wiki 板块创建新的文档主题——这是所有社区贡献的文档内容的家园。如果社区维基中的某个主题被认为相关或重要，它可能会被移至 Documentation 板块——这是所有官方 Discourse 文档的家园。您可以阅读文档政策以了解更多详情。
文档贡献者的徽章
任何在 Wiki 板块创建新主题的人都将自动获得青铜“抄写员”（Scribe）徽章：
如果该主题被认为足够有价值以移至官方 Documentation 板块，Discourse 团队将手动执行此操作，在主题内容中注明原作者，并授予其银质“幽灵作家”（Ghostwriter）徽章：
需要撰写的文档
虽然我们最终希望看到 Discourse 的每个部分都有详尽的文档，但这些是我们认为最急需完善领域的列表（删除线表示自本帖首次发布以来已撰写的主题）：
- 面向管理员的综合入门教程
- 自定义主题重定向
- 不同用户级别权限说明
- 社交登录选项
- 帖子通知（官方文档）
- 关于信任级别运作机制的更多文档
- 如何为 Discourse 撰写良好的功能请求（维基主题）
- 关于 Discourse Markdown 和格式化功能在邮件中显示方式的参考文档
- 用户状态（维基主题）
- 深色模式说明、选择方法及启用切换功能（维基主题）
- 涵盖管理用户偏好的综合文档（维基主题）
- 解释 Discourse 中分类及其层级关系的文档
- 主题设置的综合指南
- 关于插件的综合指南——什么是插件、它们如何工作以及如何使用的说明
- 自定义主页
- 更改默认分类和主题
- 在帖子中使用图片网格（维基主题）
- 帖子审核设置（维基主题）
*其中一些可能需要多个主题才能有效记录。
如何撰写文档
为了确保 Discourse 文档尽可能有效，我们提供了一份风格指南，指导如何撰写此类内容。虽然建议每个人都遵循该指南，但如果您是为 Wiki 做贡献，即使没有完全遵守也不是问题。任何移至 Documentation 的主题将由 Discourse 工作人员根据需要更新以符合风格指南。
有兴趣吗？
立即进入 Wiki 板块开始撰写文档。如果您想讨论其中任何内容，欢迎回复此主题进行交流。
12 个赞
Moin
8
现有的主题怎么样？例如
[quote=“Hugh Lashbrooke, post:1, topic:326614, username:hugh”]
如何授予用户管理员或版主权限
[/quote] Promoting a User to Admin or Moderator Status
[quote=“Hugh Lashbrooke, post:1, topic:326614, username:hugh”]
如何为 Discourse 撰写一个好的功能请求
[/quote] Requesting new features for Discourse
4 个赞
hugh
(Hugh Lashbrooke)
9
对于这个：
现有文档讨论了如何请求新功能，但没有说明如何格式化一个好的请求以使其更有效。我们目前链接到此页面，但最好我们能在 Meta 上拥有此类内容。
对于这个：
抓得好！我将在此主题中将其从列表中删除 
3 个赞
hugh
(Hugh Lashbrooke)
13
是的，这就是我们想要的
正如 @ondrej 所链接的，发布通知是指 此公告 中概述的内容。我们有该公告主题，但没有关于它的实际文档。
4 个赞
Heliosurge
(Dan DeMontmorency)
16
休·你好，这个想法很棒。
我一直想为社区维基提出一个想法，即为论坛模板之类的内容添加某种标签。
我的想法是这样的。我们经常会有人询问如何将 Discourse 用于支持论坛、学习平台等。甚至有时还会用于一些更奇特的用途，比如桌面角色扮演游戏。
收集来自这些主题的内容，甚至考虑各种用途。我们可以创建一个新的资源，其中包含一个主主题，用作索引。
这些主题可以托管在 Discourse、Communique（？）等平台上，并附带推荐的插件和主题组件等。此外，还可以有一个用于自托管的帖子。
托管模板将侧重于插件，并参考特定插件的使用所需计划。
提供技巧和窍门，甚至在需要自定义布局、插件等时引导大家前往 #marketplace。
3 个赞
这些指南已经创建但尚未勾选：
这个有点模糊。它指的是自定义主页内容吗？如果是，那么可能是 https://meta.discourse.org/t/add-custom-content-that-only-appears-on-your-homepage/131415。否则……它还没有被写出来。
2 个赞
hugh
(Hugh Lashbrooke)
23
感谢您再次联系我——我已在 OP 中更新了这些链接。
这是一个相当小众的功能，指的是创建自定义主页，因此大多数 Discourse 管理员不会使用它。它不是主要功能，因为它在这个阶段还没有完全打磨好。
2 个赞
很高兴看到这些内容！