文档导航页增加 TiDB 相关工具一级入口

文档新增需求,请按照下方模板反馈:

  • 需求类型:文档导航页优化
  • 需求背景:
    PingCAP 下现在有很多的产品、工具,尤其是 TiDB 的工具非常多,比如 DM、TiDB Operator 等。而我们每次需要访问这些工具的主页时,都需要先进入 TiDB 文档,再依次展开,再跳转到对应的文档主页,层级太深,找的麻烦。

    当然也可以直接搜索对应的工具,但在返回的结果中,“首页”不一定出现或者不是第一个结果项。尤其是对“新人”来说,通常会通篇看下文档大纲,这是首页提供的功能;搜索显然是对“老手”友好的功能。
    因此,希望在文档导航页,添加各种工具的入口。以后,只需要打开导航页,就可以进入想进入的地方了。
  • 期望增加哪些组件或者功能的文档,加到现有文档的哪个位置

    上周五改版后,我觉得挺棒,这个建议,就是希望在“文档”——“PingCAP文档中心”页添加相关工具入口(当然可以规划下,方便以后扩展)

修改建议:


如上,可以专门添加一个段落,用于展示 TiDB 工具入口(本质上,就是一个导航页面

可参考:


这是 Apache 基金会下所有开源产品的一个展示区,当然很 low,但思路可以借鉴。

1 个赞

非常感谢您的建议!我们在 TiDB 文档的首页加了 Tools 相关的板块,把常用的工具全部罗列在上面了,也非常方便用户参考。相关链接: https://docs.pingcap.com/tidb/stable

收到,之前没发现。:grinning:

所以这个需求解决了是吗?
感谢~~ 以后有任何建议随时反馈给我们。

我这边使用没问题什么。
但我个人还是建议在 https://docs.pingcap.com/zh/ 这个导航页做。毕竟这个页面就是专门做“导航”用的,而且官网 https://pingcap.com/zh/ 顶部菜单 “TiDB 文档” 跳转的是这个链接,社区 https://asktug.com/ 顶部菜单 “文档” 跳转的也是这个链接,如果这个页面在“导航页”有,无疑,访问层级更少,对用户体验更好。

有道理。我们调整好尽快上线哈。

嗯,感谢采纳:handshake:

温馨提示:我记得当初设计,“TiDB 工具”归属到 TiDB 文档下,是因为考虑到这些工具都是为 TiDB 服务的,属于周边工具。现在要统一放到“导航页”(https://docs.pingcap.com/zh/) ,是否也需要考虑下此问题,这个可能涉及到“页面的排版”。
从使用者角度看,这些周边工具都是独立产品线,没必要区分对待;从产品角度看,他们之间有“从属”关系,依赖 TiDB 生存。

该主题在最后一个回复创建后60天后自动关闭。不再允许新的回复。