代号为 Kuma 的全新 Mozilla 开发者网络 平台于本月初发布。Kuma 为文档网站带来了众多改进,包括
- 大幅提升的前端和后端性能
- 不再依赖第三方服务提供商
- 改进的编辑和翻译界面
- 增强的宏创建语言,称为 KumaScript
- 能够更快地将代码推送到生产环境
- …… 等等!
简而言之:我们创建了工具,使任何人都能更轻松地参与 MDN 的贡献。参与 MDN 的方式有很多,以下是对如何为网络上最好的文档网站做出贡献的简要概述。
撰写
优秀的技术文档始终是刚需,尤其是在涉及前沿 Web 技术时。扎实的文档和细节有助于更广泛、更快速地采用这些技术。Mozilla 开发者网络致力于提供关于新旧 Web 技术最准确和详细的文档。通过创建新的文档、更新现有的文档,或仅仅修复损坏的链接或错别字,您都将有助于提高 MDN 文档的质量。您的更新将被全球数百万开发人员看到,从而有助于改善整个 Web。
Kuma 的文档是通过 Wiki 格式创建的,允许任何人都可以登录并创建或丰富文档。Kuma 的所见即所得编辑器已针对最佳技术文档目的进行了定制,并且实施了一个名为 KumaScript 的单独模板系统,以便可以在文档中创建和使用宏。每天都会创建新的编辑功能,我们期待继续这项工作。
翻译
Kuma 的主要关注点之一是改进翻译 API。翻译人员现在可以并排查看现有内容,使翻译变得非常方便快捷。RSS Feed 可显示英文文档的更新,以便翻译人员知道何时需要更新外语翻译。翻译现有内容的好处在于,您可以为不懂英语的人打开一个技术文档的世界。如果您希望将文档翻译成 MDN 尚未支持的语言,请告知我们,我们可以将该语言添加到支持语言列表中。
修复 Bug,添加功能
与其他 Mozilla 网站和应用程序一样,Kuma 代码已开源,并在 GitHub 上提供。提供了 详细的安装说明,您应该可以在几分钟内完成本地 MDN 安装。下一步是 fork Kuma 存储库,以便您拥有一个可以从中发送拉取请求的存储库。
MDN Bug 列表可在 Bugzilla 中找到;列表包括 网站 Bug 和 文档平台 Bug。每个 Bug 报告都提供了有关应修复、增强或创建的内容的详细信息。如果您发现想要解决的 Bug,请将其分配给自己,创建一个新的分支(在名称中包含 Bug 编号),然后开始编码!
修复完成后,向 Mozilla 存储库发送拉取请求,提供 Bug 编号以及修复的简要说明。我们将测试您的解决方案,一旦证明有效,就会将您的代码合并到 MDN 中。然后,您就可以说您帮助编写了 MDN 的一部分!
提交 Bug
Mozilla 开发者网络尚未完美,但我们正在努力实现它。如果您不熟悉贡献代码或编写文档,但发现 MDN 上有某些内容看起来不正确,或者看到改进的空间,请 提交 Bug。我们的开发团队将优先处理社区提供的 Bug 并进行相应的修复。任何帮助识别改进途径都将不胜感激!
推广 MDN
宣传 MDN 会鼓励其他人参与贡献和改进 MDN。最近还发布了 推广 MDN WordPress 插件;这是一个轻量级插件,可分析页面内容并创建指向 MDN 上详细解释该术语的页面的链接。您还可以构建自己的 MDN 徽章 来推广 Mozilla 开发者网络。
您可以通过多种方式帮助 Mozilla 开发者网络发展和改进。无论您的兴趣和才能在于撰写原创内容、翻译现有内容、编写新功能和修复 Bug,还是仅仅帮助推广 MDN,您都可以在使 MDN 对其他开发社区更有用方面发挥重要作用。如果您有更多关于入门的问题,请访问 #mdn IRC 房间 并提出问题。我们期待您的帮助和支持!
6 条评论