Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.Original topic: 文档导航页增加 TiDB 相关工具一级入口
|
username: MyronWang
New Documentation Request, please provide feedback according to the template below:
- Request Type: Documentation Navigation Page Optimization
- Request Background:
PingCAP now has many products and tools, especially TiDB tools such as DM, TiDB Operator, etc. Every time we need to access the homepage of these tools, we have to first enter the TiDB documentation, then expand it step by step, and then jump to the corresponding documentation homepage. The hierarchy is too deep, making it troublesome to find.
Of course, you can also directly search for the corresponding tool, but in the returned results, the “homepage” may not appear or may not be the first result item. Especially for “newcomers,” they usually look through the entire document outline, which is a function provided by the homepage; searching is obviously a feature friendly to “veterans.”
Therefore, I hope to add entrances to various tools on the documentation navigation page. In the future, you only need to open the navigation page to enter the place you want to go. - Expected components or functions to be added to the existing documentation and their positions
After the revision last Friday, I think it’s great. This suggestion is to hope to add relevant tool entrances on the “Documentation” - “PingCAP Documentation Center” page (of course, it can be planned for future expansion)
Modification Suggestions:
As shown above, a dedicated section can be added to display the TiDB tool entrances (essentially, it’s a navigation page)
Reference:
This is a display area for all open-source products under the Apache Foundation. Although it looks low, the idea can be borrowed.
|
username: 
