how-to: add quick-start-with-tidb doc #2320
Conversation
ran-huang
added
translation/from-docs-cn
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
TOC.md
Outdated
| + How-to | ||
| + Get Started | ||
| + Start a Cluster | ||
| - [Quick Start with TiDB](/how-to/get-started/quick-start-with-tidb.md) |
There was a problem hiding this comment.
This guide looks great! I would like to suggest moving this guide to be right behind the Introduction on the main TOC.
There was a problem hiding this comment.
Please change the title to be "Quick Start Guide for the TiDB Database Platform". This is to avoid the possible confusion of the TiDB server component and the entire TiDB database platform.
|
@yikeke Comments addressed. PTAL~ |
|
@queenypingcap Comments addressed. PTAL~ |
It‘s okay to keep the Title in ToC as it is. |
TOC.md
Outdated
|
|
||
| + Introduction | ||
| - [TiDB Introduction](/overview.md) | ||
| - [Quick Start with TiDB](/how-to/get-started/quick-start-with-tidb.md) |
There was a problem hiding this comment.
| - [Quick Start with TiDB](/how-to/get-started/quick-start-with-tidb.md) | |
| - [Quick Start Guide for the TiDB Database Platform](/how-to/get-started/quick-start-with-tidb.md) |
Do we need to change the file location as the ToC suggests? @queenypingcap
There was a problem hiding this comment.
Please change the file location and the ToC link, thx~ @ran-huang
There was a problem hiding this comment.
What do you think of moving it one level up to be in parallel with Introduction? It may not make sense if you think it strictly from how it should be categorized, but it is the most important information a reader wants to read.
There was a problem hiding this comment.
I might consider it a good trade-off. It's worth trying at least for some time. If anyone poses a challenge to the file location, we can re-discuss it with more feedback then.
|
/merge |
sre-bot
added
the
status/can-merge
yikeke
removed
the
status/can-merge
|
/run-all-tests |
* how-to: add quick-start-with-tidb doc * test markdownlint * revert the change * Apply suggestions from coco Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com> * Apply suggestions from coco Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com> * move the notes * address comments * move the file location and edit toc * fix an anchor link Co-authored-by: Lilian Lee <lilin@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
|
cherry pick to release-4.0 in PR #2338 |
* how-to: add quick-start-with-tidb doc * test markdownlint * revert the change * Apply suggestions from coco Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com> * Apply suggestions from coco Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com> * move the notes * address comments * move the file location and edit toc * fix an anchor link Co-authored-by: Lilian Lee <lilin@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com> Co-authored-by: Ran <huangran@pingcap.com> Co-authored-by: Lilian Lee <lilin@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
|
I align @queenypingcap 's suggested changes in pingcap/docs-cn#2827. Please help check whether I missed anything. @ran-huang |
6 participants
What is changed, added or deleted? (Required)
Add the quick-start-with-tidb doc.
Which TiDB version(s) do your changes apply to? (Required)
If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-4.0, needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.
What is the related PR or file link(s)?