Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.1 KB

工作流程

Istio 知识图谱工作组工作流程如下:

  1. 编辑本文档中的知识图谱;
  2. 可以直接把正文部分复制粘贴保存为 Markdown,在 MindNode 里打开就可以看到脑图;
  3. 导出 PDF、Markdown、PNG 格式的文件;
  4. 最终归档到 https://github.com/servicemesher/istio-knowledge-map
  5. 参考 https://github.com/dformoso/machine-learning-mindmap

编辑工具推荐:

  1. Atom + Markdown Mindmap(插件)- 支持 Markdown Mindmap 直接编辑 (多平台/免费)
  2. MindNode 支持打开和导出 Markdown Mindmap,但保存还是MindNode私有格式,操作略繁琐 (Mac平台/收费)

样式指南

关于 Istio 知识图谱中的样式,遵循如下原则:

  1. 纯文本,不出现图片;
  2. 英文、数字和中文之间请加一个空格;
  3. 关于 Istio 中的专业术语请保持与官方文档相同即可,请参考术语与习惯用语
  4. 标题尽量不要使用疑问句;