首页 赞赏支持 QQ群 微信公众号 更新日志 新手常见问题 参与文档编辑
# 参与文档编辑
有意愿的同学可以联系一下酷酷的诚(QQ群或者公众号) 告知参与文档贡献 码云文档库地址:https://gitee.com/nifichina/nifi-docs-vuepress/tree/master/docs
贡献文档流程(常规PR)
- fork文档库
- 每次新建文档,在你的码云fork下来的文档库里新建分支。编辑好文档,提交PR(Pull Request)即可。
- 酷酷的诚审核和二次编辑后,合并入项目,更新部署pages
贡献文档流程(轻量级PR) 建议使用这个
- 使用码云轻量级PR码云轻量级PR文档 (opens new window)
- 新建文档,编辑文档
- 酷酷的诚审核和二次编辑后,合并入项目,更新部署pages
文档编写流程
- 使用Markdown语法
- 项目目录结构
- code:涉及NIFI源码 NIFI配置 教程等等文章的集合
- extend:与NIFI相关的一些知识、文章
- general:NIFI指南
- developer:NIFI开发者指南
- processors:Processor组件文档
- controllerservice:Controller Service组件文档
- reportingtask:ReportingTask组件文档
- index:首页的其他目录
- image:md文档里相关的图片(酷酷的诚会二次编辑图片,图片会统一存放在一个图床中)
- 示例:在processors目录下 新建一个MyProcessor.md(参照其他md文档格式),编辑完后提交PR即可
- 推荐工具:vscode
- vscode推荐插件:docs-markdown Comment Translate
注意事项:
- 组件文档以组件名称命名
- 如果有示例说明,更有意义
- 可以使用翻译工具,但一定要自己阅读一遍,保证编辑出来的中文文档是能够读懂的。
- 文档参考官方最新文档进行输出