Skip to content

文档提交指南

JackyZhou edited this page Mar 10, 2020 · 2 revisions

提交到哪?

DevOps文档库与代码库做了分离,所有相关的技术文档均需要提交到boat-house-devops库,地址如下:

https://github.com/idcf-boat-house/boat-house-devops

提交规范?

  • 格式:所有文档均需要使用Markdown的方式编写。

  • 存放:所有文档均需要在docs目录下创建一个文件夹用于存放图片以及文档,参考如下:

docs
	- 技术主题 (文件夹)
		- images (文件夹)
		- Readme.md (技术主题文档)