文档贡献机会

[hugh (Hugh Lashbrooke)]

Discourse 文档是管理员、版主、用户和系统管理员查找有关使用 Discourse 和管理其站点帮助的主要位置。

虽然这些文档内容丰富且涵盖广泛，但仍有一些我们尚未记录的领域。这是一个让社区参与进来帮助完善 Discourse 项目这一重要部分的好机会。

我们希望看到更多人参与到为 Discourse 创建文档内容中来，并希望尽可能让任何人都能轻松做到。为此，下面列出了我们已确定需要新文档或改进文档的 Discourse 功能或用例。

文档位置

信任等级为 2 或更高级别的任何人都可以创建新的文档主题，放在 Community wiki 中——这是所有社区贡献的文档内容的主页。如果社区维基中的某个主题被认为相关或重要，它可能会被移至 Documentation——这是所有官方 Discourse 文档的主页。您可以阅读 文档策略 以获取更多详细信息。

文档贡献者徽章

任何在 Community wiki 类别中创建新主题的人都将自动获得铜牌“抄写员”徽章：

如果某个主题被认为足够有价值，可以移至官方的 Documentation 类别，Discourse 团队的某个人将手动完成此操作，在主题内容中注明原作者，并为其分配银牌“代笔”徽章：

需要编写的文档

虽然我们最终希望看到 Discourse 的每个部分都得到详尽的记录，但以下是我们认为最紧迫的领域（已划掉的项目表示自本帖首次发布以来已编写的主题）：

• 管理员的通用入门教程
• 自定义主题重定向
• 解释不同用户级别可以做什么
• 社交登录选项
• 发布通知（官方文档）
• 关于信任级别如何工作的更多文档
• 如何为 Discourse 撰写有效的需求建议（维基主题）
• 关于 Discourse markdown 和格式功能在电子邮件中显示效果的参考
• 用户状态（维基主题）
• 关于暗模式的解释、如何选择它以及如何启用切换（维基主题）
• 通用文档，涵盖用户偏好设置的管理（维基主题）
• 解释 Discourse 中类别和层级结构的文档
• 主题设置的通用指南
• 关于插件的通用指南——它们是什么、如何工作以及如何使用它们
• 自定义主页
• 更改默认类别和主题
• 在帖子中使用图片网格（维基主题）
• 帖子审批设置（维基主题）

其中一些可能需要多个主题才能有效记录。

如何编写文档

为了确保 Discourse 文档尽可能有效，我们有一个关于如何编写这些内容的 风格指南。虽然希望每个人都能遵循该指南，但如果您为 Community wiki 贡献内容，即使没有完全遵守它也没关系。任何被移至 Documentation 的主题都将由 Discourse 员工根据需要进行更新，以匹配风格指南。

感兴趣？

立即加入 Community wiki 开始记录。如果您想讨论其中任何内容，请随时回复此主题进行讨论。

[Moin]

现有的主题怎么样？例如

[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

[hugh (Hugh Lashbrooke)]

对于这个：

@Moin

@hugh

如何撰写一个好的 Discourse 功能请求

请求 Discourse 新功能

现有文档讨论了如何请求新功能，但没有说明如何格式化一个好的请求以使其更有效。我们目前链接到此页面，但最好我们能在 Meta 上拥有此类内容。

对于这个：

@Moin

@hugh

如何授予用户管理员或版主权限

向用户授予管理员或版主权限

抓得好！我将在此主题中将其从列表中删除

[ondrej]

@hugh

如何为 Discourse 撰写一个好的功能请求

已经有一个关于功能请求的主题了

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

除非它需要看起来像这样，但用于功能请求？

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@hugh

发布通知

这是指“员工通知”还是其他意思？

[ondrej]

我猜这是一个帖子通知，因为它在标题中

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

工作人员通知基本上也是一样的吧？

[hugh (Hugh Lashbrooke)]

@ondrej

除非它看起来像这样，但用于功能请求？

是的，这就是我们想要的

@HamMan2118

@hugh

发布通知

这是指员工通知还是其他什么？

正如 @ondrej 所链接的，发布通知是指 此公告 中概述的内容。我们有该公告主题，但没有关于它的实际文档。

[Heliosurge (Dan DeMontmorency)]

休·你好，这个想法很棒。

我一直想为社区维基提出一个想法，即为论坛模板之类的内容添加某种标签。

我的想法是这样的。我们经常会有人询问如何将 Discourse 用于支持论坛、学习平台等。甚至有时还会用于一些更奇特的用途，比如桌面角色扮演游戏。

收集来自这些主题的内容，甚至考虑各种用途。我们可以创建一个新的资源，其中包含一个主主题，用作索引。

• 支持论坛模板
• 学习平台模板

这些主题可以托管在 Discourse、Communique（？）等平台上，并附带推荐的插件和主题组件等。此外，还可以有一个用于自托管的帖子。

托管模板将侧重于插件，并参考特定插件的使用所需计划。

提供技巧和窍门，甚至在需要自定义布局、插件等时引导大家前往 #marketplace。

[NateDhaliwal]

@hugh

用户状态

已创建：

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

[hugh (Hugh Lashbrooke)]

我看到了 很高兴看到这些内容！

[NateDhaliwal]

正在处理暗模式。

[NateDhaliwal]

这些指南已经创建但尚未勾选：

@hugh

用户状态

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

@hugh

在帖子中使用图片网格

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

自定义主页

这个有点模糊。它指的是自定义主页内容吗？如果是，那么可能是 https://meta.discourse.org/t/add-custom-content-that-only-appears-on-your-homepage/131415。否则……它还没有被写出来。

[hugh (Hugh Lashbrooke)]

感谢您再次联系我——我已在 OP 中更新了这些链接。

@NateDhaliwal

这个有点模糊。它指的是自定义主页内容吗？

这是一个相当小众的功能，指的是创建自定义主页，因此大多数 Discourse 管理员不会使用它。它不是主要功能，因为它在这个阶段还没有完全打磨好。