社区新增文档流程

TC Docs SIG
1

1、文档存放平台
在openUBMC社区，文档的归档有三种途径：
【openUBMC文档中心】：openUBMC官方介绍文档，署名归openUBMC，旨在指导社区开发者开发、测试等。
【博客】：收集openUBMC社区的精选文章，署名归作者，旨在鼓励社区开发者踊跃分享、积极讨论，开拓思维等，属于社区文档的中坚力量。
【openUBMC社区论坛】：讨论、交流为主，署名归作者。

2、openUBMC-Docs仓文档规范
文档上库需要满足规范，具体见：【文档开发指南】

3、文档类别
新增文档类别主要分为需求类文档和非需求类文档
非需求类文档可以分为：① 标准规范类文档，如Redfish接口文档 ② 其他非需求类文档，如个人文档等

2.1 需求类文档
需要提issue和PR上传到Docs仓
新增文档的路径需要咨询SIG Docs或者在Docs版块中询问

Docs仓新增文档示例
以在开发者指南/开发指南/特性开发添加一篇命名为pcie配置的文档为例
①在docs/public/menu/development/menu.json添加映射

[
  {
    "id": "develop_guide",
    "label": {
      "zh": "开发指南",
      "en": "Develop guide"
    },
    "children": [
      {
        ...
      {
        "id": "feature_development",
        "label": {
          "zh": "特性开发",
          "en": "Product Development"
        },
        "children": [
          {
            ...
            "id": "pcie_configuration",
            "label": {
              "zh": "pcie配置",
              "en": "pcie configuration"
            }
          }
        ]
      }
    ]
  }
...
]

②在docs/zh/development/develop_guide/feature_development/路径下创pcie_configuration.md，并书写内容

image
image2234×935 159 KB

③提issue和PR
在docs仓里面提issue
image
image1238×658 13.4 KB

在PR上关联相应的issue
image
image1677×884 51.5 KB

2.2 非需求类文档
1）规范和标准类文档，可以找SIG Docs组评审，评审通过后，按照需求类文档流程提PR和测试后即可放在docs仓
2）其他文档
其发表途径有两种：
① 可以发表在社区论坛，sig-docs组会定期审视社区论坛中的帖子，浏览量高、热度高和质量优异等的帖子将会上线openUBMC社区博客

image
image2272×1404 162 KB

② 自荐：可以将文档通过邮件形式发送到 docs@public.openubmc.cn。sig-docs组将会在一周内答复，审核通过的文档将会上线openUBMC社区博客。

2 个赞