how-to: add quick-start-with-tidb doc by ran-huang · Pull Request #2320 · pingcap/docs

ran-huang · 2020-04-17T05:35:24Z

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)?

This PR is translated from: how-to: add TiUP quick start doc quick-start-with-tidb.md docs-cn#2710
Other reference link(s):

superlzs0476

LGTM

yikeke

Well done! I just made some small suggestions.

yikeke

PTAL @queenypingcap

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

QueenyJin · 2020-04-19T10:47:25Z

 + How-to
  + Get Started
    + Start a Cluster
+      - [Quick Start with TiDB](/how-to/get-started/quick-start-with-tidb.md)


This guide looks great! I would like to suggest moving this guide to be right behind the Introduction on the main TOC.

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.

ran-huang · 2020-04-19T14:00:07Z

@yikeke Comments addressed. PTAL~

ran-huang · 2020-04-19T14:01:08Z

@queenypingcap Comments addressed. PTAL~
Also, I only changed the title in the file to Quick Start Guide for the TiDB Database Platform, but left the title in TOC as it was (Get Started with TiDB). This is because I think given the TOC context, users can hardly confuse the TiDB component with the TiDB platform, and a long title might look awkward in the left-hand navigator.

QueenyJin · 2020-04-19T14:19:03Z

@queenypingcap Comments addressed. PTAL~
Also, I only changed the title in the file to Quick Start Guide for the TiDB Database Platform, but left the title in TOC as it was (Get Started with TiDB). This is because I think given the TOC context, users can hardly confuse the TiDB component with the TiDB platform, and a long title might look awkward in the left-hand navigator.

It‘s okay to keep the Title in ToC as it is.

yikeke · 2020-04-20T03:06:05Z


 + Introduction
  - [TiDB Introduction](/overview.md)
+  - [Quick Start with TiDB](/how-to/get-started/quick-start-with-tidb.md)


Suggested change

- [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

Yes, please do

Please change the file location and the ToC link, thx~ @ran-huang

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.

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.

Updated. PTAL~@queenypingcap @yikeke

QueenyJin

LGTM

yikeke

LGTM

yikeke · 2020-04-20T07:06:34Z

/merge

sre-bot · 2020-04-20T07:08:57Z

/run-all-tests

yikeke

LGTM

* 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>

sre-bot · 2020-04-20T07:17:51Z

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>

yikeke · 2020-04-20T09:27:04Z

I align @queenypingcap 's suggested changes in pingcap/docs-cn#2827. Please help check whether I missed anything. @ran-huang

how-to: add quick-start-with-tidb doc

0399ddc

ran-huang added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. needs-cherry-pick-4.0 labels Apr 17, 2020

ran-huang requested review from lilin90 and superlzs0476 April 17, 2020 05:35

lilin90 requested a review from yikeke April 17, 2020 05:48

Merge branch 'master' into tiup-quick-start

f52e72b

ran-huang commented Apr 17, 2020

View reviewed changes

Comment thread how-to/get-started/quick-start-with-tidb.md

test markdownlint

5b7592c

ran-huang commented Apr 17, 2020

View reviewed changes

Comment thread how-to/get-started/quick-start-with-tidb.md Outdated

revert the change

dfdac12

superlzs0476 approved these changes Apr 17, 2020

View reviewed changes

yikeke reviewed Apr 18, 2020

View reviewed changes

yikeke mentioned this pull request Apr 18, 2020

get-started: fix some descriptions and typos in tiup quick start doc pingcap/docs-cn#2813

Merged

5 tasks

sre-bot mentioned this pull request Apr 18, 2020

get-started: fix some descriptions and typos in tiup quick start doc (#2813) pingcap/docs-cn#2814

Merged

5 tasks

yikeke suggested changes Apr 19, 2020

View reviewed changes

yikeke requested a review from QueenyJin April 19, 2020 11:12

ran-huang and others added 4 commits April 19, 2020 19:20

Merge branch 'master' into tiup-quick-start

639e8b3

Apply suggestions from coco

1c51c72

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

Apply suggestions from coco

d3ddcf9

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

move the notes

750de5b

QueenyJin reviewed Apr 19, 2020

View reviewed changes

address comments

e034803

yikeke reviewed Apr 20, 2020

View reviewed changes

move the file location and edit toc

90854ec

QueenyJin approved these changes Apr 20, 2020

View reviewed changes

yikeke approved these changes Apr 20, 2020

View reviewed changes

sre-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 20, 2020

Merge branch 'master' into tiup-quick-start

d5eae97

yikeke removed the status/can-merge Indicates a PR has been approved by a committer. label Apr 20, 2020

yikeke suggested changes Apr 20, 2020

View reviewed changes

Comment thread quick-start-with-tidb.md Outdated

fix an anchor link

2cf9eb5

yikeke approved these changes Apr 20, 2020

View reviewed changes

yikeke merged commit 3114615 into pingcap:master Apr 20, 2020

sre-bot mentioned this pull request Apr 20, 2020

how-to: add quick-start-with-tidb doc (#2320) #2338

Merged

5 tasks

yikeke mentioned this pull request Apr 20, 2020

quick-start: update quick start guide for TiDB pingcap/docs-cn#2827

Merged

5 tasks

ran-huang deleted the tiup-quick-start branch April 20, 2020 09:28

sre-bot mentioned this pull request Apr 20, 2020

quick-start: update quick start guide for TiDB (#2827) pingcap/docs-cn#2835

Merged

5 tasks

	- [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)

Conversation

ran-huang commented Apr 17, 2020 • edited by yikeke Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Uh oh!

Uh oh!

Uh oh!

superlzs0476 left a comment

Choose a reason for hiding this comment

Uh oh!

yikeke left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yikeke left a comment

Choose a reason for hiding this comment

Uh oh!

QueenyJin Apr 19, 2020

Choose a reason for hiding this comment

Uh oh!

QueenyJin Apr 19, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ran-huang commented Apr 19, 2020

Uh oh!

ran-huang commented Apr 19, 2020

Uh oh!

QueenyJin commented Apr 19, 2020

Uh oh!

yikeke Apr 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QueenyJin Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

yikeke Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

QueenyJin Apr 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yikeke Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

ran-huang Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

QueenyJin left a comment

Choose a reason for hiding this comment

Uh oh!

yikeke left a comment

Choose a reason for hiding this comment

Uh oh!

yikeke commented Apr 20, 2020

Uh oh!

Uh oh!

sre-bot commented Apr 20, 2020

Uh oh!

ran-huang commented Apr 17, 2020 •

edited by yikeke

Loading

yikeke left a comment •

edited

Loading

yikeke Apr 20, 2020 •

edited

Loading

QueenyJin Apr 20, 2020 •

edited

Loading

yikeke commented Apr 20, 2020 •

edited

Loading