hongming https://github.com/kubesphere/kubesphere/tree/master/docs/en/guides 可以先看看现有的一些文档,逐步完善中,欢迎参与到社区中来。
chenpfeisoo 感谢官方积极开放的态度,目前一有的文档我翻看过 类似标准性的要求较多, 正如楼上所说,我们可能需要的是官方对各个大模块的梳理指导性的文档,不必过细 ,但是能对初入社区的开发者以指导,模块定界就好 Feynman hongming
iiiiiiiiiiiiiiiii Feynman 我想提个需求:最好能有详细的代码说明,虽然代码有部分注释,但是对于不熟悉的人来说,看起来还是感觉有点吃力,建议能够把每个模块相关的代码分类介绍一下,或者把pkg目录下的包介绍一下,最好能介绍一下哪个包属于哪个模块的,大体有什么功能;
i070595 单元测试开发要求。单元测试开发要求,形式,范例以及覆盖率的要求 模块以及插件架构介绍。对系统中的各个模块的目的,使命,输入,输出,上下游依赖情况详细的描述。 系统架构体系详细介绍 部署架构体系详细介绍,以及部署方式介绍 第三方插件开发举例 各个模块依赖配置文件模版,及各个配置项说明 另外:可以参考一下耐飞的spinnaker,他们文档不多 但是到位 每个模块中都有readme 怎么配置和运行。 本地能 debug 社区才会热,如果配置个环境 需要这需要那 配置复杂 热度也不会起来,配置越简单 上手越快 传播就快
cnicy 1、技术架构说明:整体架构设计说明、框架设计、每个模块用到什么技术框架、哪个版本可以在架构图上标明; 2、业务架构说明:复杂的业务尽量画出业务流程图、时序图等,每个流程流转条件和关系是什么方便大家梳理代码逻辑; 3、实现细节:每个模块的实现细节,越多越好; 4、代码规约说明; 5、代码调试、编译、部署手册,用到的工具详细描述清楚(这一点很重要); PS: Dubbo 的开发者指南写得很好,可以参考
runzexia 我们在编写一些开发文档,现在在 review 过程中。希望社区可以一起参与 review 过程,如果有什么不好理解的可以给我们一些回复,我们可以继续改进。 https://github.com/kubesphere/kubesphere/pull/1681/ https://github.com/kubesphere/kubesphere/pull/1677/ https://github.com/kubesphere/kubesphere/pull/1685/ https://github.com/kubesphere/kubesphere/pull/1689
Feynman TinaSprunt 在 kubesphere/community 仓库有,近期刚刚更新了编译文档:https://github.com/kubesphere/community/pull/172/files