Gitbook
Download PDF:
- 从 Project 找到感兴趣地模块
- 在具体模块的 TODO 列表中选择一个感兴趣的任务。
- 将内容提交 Pull Request
选题参考目录:
文章内容格式采用 markdown.
图片存放目录与文章存放一一对应,图片存放目录:
- 其中 为对应文章路径。
如例:
- 文章存放路径:
- 对应图片存放目录为:
- 图片路径对应到 markdown 里为:
《TiDB in Action》是一本重视实操的书
- 工具的介绍和使用部分会深入浅出,浅显易懂,这一部分可以当作工具书来查阅。
- 原理与实现部分会相对言简意赅,意在帮助读者能够理解原理,从而更好地使用 TiDB。但无需陷入具体实现细节中,这部分读者浅尝辄止即可。
关于特性和产品介绍
- 介绍工具的简单原理
- 介绍工具如何使用(常见的参数,常见的应用场景)
- 给出一两个简单的例子
关于最佳实践
- 轻原理,重实操
- 贴原理实现的代码
- 直接复制粘贴案例,但是无操作流程
- 对工具只介绍,不给例子
- 选择的例子是个特例(不可复现)
建议读者在阅读过程中,修正后的内容需要:
- 标题能够突出本章重点,言简意赅,忌:词不达意,
- 内容上下文衔接顺畅,逻辑通顺,忌:
- 技术点错误
- 内容描述不清晰的,语句不通
- 章节缺少开头、总结
此外,如果您有地方读不懂,想要修改又无从下手,请在内容附近使用 markdown 惯用的隐藏注释提问:
Shield: