文档贡献

怎么贡献文档?

点击顶部”编辑此页”按钮即可进入源码仓库对应的文件,开发人员将修改(添加)的文档通过pr形式提交, 我们收到pr后会进行文档审核,一旦审核通过即可更新文档。 doc-edit

可以贡献哪些文档?

  • 文档编写错误
  • 文档不规范、不完整
  • go-zero应用实践、心得
  • 组件中心

文档pr通过后文档多久会更新?

在pr接受后,github action会自动build gitbook并发布,因此在github action成功后1-2分钟即可查看更新后的文档。

文档贡献注意事项

  • 纠错、完善源文档可以直接编写原来的md文件
  • 新增组件文档需要保证文档排版、易读,且组件文档需要放在组件中心子目录中
  • go-zero应用实践分享可以直接放在开发实践子目录下

目录结构规范

  • 目录结构不宜过深,最好不要超过3层
  • 组件文档需要在归属到组件中心,如
    1. * [开发实践]($practise.md)
    2. * [logx]($logx.md)
    3. * [bloom]($bloom.md)
    4. * [executors]($executors.md)
    5. * 你的文档目录名称
  • 应用实践需要归属到开发实践,如
    1. * [开发实践]($practise.md)
    2. * [我是如何用go-zero 实现一个中台系统]($datacenter.md)
    3. * [流数据处理利器]($stream.md)
    4. * [103日线上交流问题汇总](online-exchange.md
    5. * 你的文档目录名称

开发实践文档模板

  1. # 标题
  2. > 作者:填入作者名称
  3. >
  4. > 原文连接: 原文连接
  5. some markdown content

猜你想看