文档新增需求,请按照下方模板反馈:
- 需求类型:文档导航页优化
- 需求背景:
PingCAP 下现在有很多的产品、工具,尤其是 TiDB 的工具非常多,比如 DM、TiDB Operator 等。而我们每次需要访问这些工具的主页时,都需要先进入 TiDB 文档,再依次展开,再跳转到对应的文档主页,层级太深,找的麻烦。
当然也可以直接搜索对应的工具,但在返回的结果中,“首页”不一定出现或者不是第一个结果项。尤其是对“新人”来说,通常会通篇看下文档大纲,这是首页提供的功能;搜索显然是对“老手”友好的功能。
因此,希望在文档导航页,添加各种工具的入口。以后,只需要打开导航页,就可以进入想进入的地方了。 - 期望增加哪些组件或者功能的文档,加到现有文档的哪个位置
上周五改版后,我觉得挺棒,这个建议,就是希望在“文档”——“PingCAP文档中心”页添加相关工具入口(当然可以规划下,方便以后扩展)
修改建议:
如上,可以专门添加一个段落,用于展示 TiDB 工具入口(本质上,就是一个导航页面)
可参考:
这是 Apache 基金会下所有开源产品的一个展示区,当然很 low,但思路可以借鉴。