社区新知 | 参与WG-Doc，你所不知道的贡献者成长攻略

2021/01/26

社区新知 | 参与WG-Doc，你所不知道的贡献者成长攻略

MindSpore WG-doc，全称MindSpore Doc Working Group，旨在改善MindSpore文档和相关的学习资源，使社区成员能够在重要领域贡献力量并协助维护新特性，从而更好的帮助更多开发人员来学习和使用MindSpore。下面就让我们来看看WG-doc具体由哪些部分组成以及如何参与其中。

docs是MindSpore开源社区上的一个仓库，docs仓包含了MindSpore官网上的所有文档，包括安装、教程、文档的源文件以及各类API的工程文件等。同时请尽情提交PR到docs仓吧，我们欢迎所有意见和建议。有任何疑问可以提issue，我们会及时答复的。

· MindSpore官网：https://www.mindspore.cn

· docs仓：https://gitee.com/mindspore/docs

MindSpore docs仓的分支设置与MindSpore社区发布版本是保持一致的，各分支对应官网中相应版本的内容。以下是MindSpore docs仓分支示意图：

以下是MindSpore官网版本示意图：

其中，master分支对应的网页会每日更新，其余分支均在对应版本发布时上线。所有版本的发布件和资料地址可查看发布版本列表。

如果你有新特性文档或是想要对现有文档进行完善，请确认要提交的分支，并关注PR合入情况。

· 发布版本列表：https://www.mindspore.cn/versions/

仓库文档的目录结构如下，各工程内分别设置了source_zh_cn和source_en目录，用于存放中文和英文文档。

docs

├───docs // 架构、网络和算子支持、编程指南等技术文档以及用于生成API的相关配置文件

| |

| ├───api_cpp // C++ API工程

| |

| ├───api_java // Java API工程

| |

| ├───api_python // Python API工程

| |

| ├───faq // 常见问题

| |

| ├───note // 设计和规格

| |

| └───programming_guide // 编程指南相关文档

│

├───install // 安装指南

│

├───lite // MindSpore Lite相关所有文档汇总及其链接

│

├───resource // 资源相关文档

│

├───tools // 自动化工具

│

├───tutorials // 教程相关文档

| |

| ├───inference // 推理教程相关文档

| |

| ├───lite // 手机及IoT教程相关文档

| |

| ├───notebook // 体验式文档

| |

| ├───training // 训练教程相关文档

| |

| ├───tutorial_code // 教程对应样例代码

│

└───README_CN.md // Docs仓说明

需要注意的是，以上结构会随版本演进而变化，请以说明文档中的目录结构说明描述为准。 · 说明文档：https://gitee.com/mindspore/docs/blob/master/README_CN.md#目录结构说明

欢迎大家在MindSpore docs仓建立issue参与讨论，让MindSpore文档更加完善。更欢迎大家提交PR到MindSpore docs仓一起来参与贡献，符合要求的文档将会在MindSpore官网中呈现哦。参与文档贡献，您将获得以下权益：

1. 熟悉开源流程

我们提供了完整的开源文档参与机制，你可以参与文档内容修正、补充、翻译等任务，也可以参与MindSpore API注释的写作等任何感兴趣的任务，总有一款适合你！通过文档贡献，你可以熟悉开源的参与方式、运作流程，为后续参与到MindSpore代码开发或其他开源项目打下扎实的基础。详细的参与方式，请参见MindSpore贡献指南和贡献文档指南里面有详细的规范要求和样例，如果还有问题，也欢迎给我们留言哦。

· MindSpore贡献指南：

https://gitee.com/mindspore/mindspore/blob/master/CONTRIBUTING.md

· 贡献文档指南

https://gitee.com/mindspore/docs/blob/master/CONTRIBUTING_DOC_CN.md

2. 0门槛参与MindSpore项目

MindSpore项目从2020年3月28日开源以来，深受广大开发者的欢迎，获得2020年度OSC中国开源最佳人气项目、中国人工智能最佳技术社区TOP5等奖项。可以说是好评如潮~

其中，文档是最为快速参与MindSpore项目的方式。只要你发现文档中存在待完善的内容，或者有使用MindSpore的经验，都可以通过贡献文档的方式参与到WG-doc，您的参与很有可能会为其他开发者提供有帮助的信息。

我们也会发布简单的issue到docs仓，欢迎大家通过接受这类issue来参与贡献。

· docs仓：https://gitee.com/mindspore/docs/issues

3. 奖励和认证

积极参与MindSpore文档贡献和论坛干货分享者，将有机会获得丰厚的奖品哦~ 我们准备了MindSpore官方书籍给好学的你，以及精美的MindSpore定制礼品，包括但不限于T恤、卫衣、雨伞、帆布袋等，是不是很心动呢~

授予优秀参与者荣誉称号，名单官网展示、专属奖品、官方大会门票等奖励，绝对的高大上！