-
格式:所有文档均需要使用Markdown的方式编写。
-
存放:所有文档均需要在docs目录下创建一个文件夹用于存放图片以及文档,参考如下:
docs
- 技术主题 (文件夹)
- images (文件夹)
- Readme.md (技术主题文档)
- 提交的每个文档需要能独立使用,不能与其他文档有依赖关系。
- 文档需要包含详尽的内容以及截图,确保其他组成员按照文档完成DevOps相关的实践以及学习。
- 如果文档中有脚本或代码,需要将脚本贴入Markdown,不要使用图片的方式。
格式:所有文档均需要使用Markdown的方式编写。
存放:所有文档均需要在docs目录下创建一个文件夹用于存放图片以及文档,参考如下:
docs
- 技术主题 (文件夹)
- images (文件夹)
- Readme.md (技术主题文档)