Skip to content

tools: add a guide for choosing TiDB Ecosystem Tools#2210

Merged
sre-bot merged 26 commits into
pingcap:masterfrom
WangXiangUSTC:xiang/tools_guide
Feb 12, 2020
Merged

tools: add a guide for choosing TiDB Ecosystem Tools#2210
sre-bot merged 26 commits into
pingcap:masterfrom
WangXiangUSTC:xiang/tools_guide

Conversation

@WangXiangUSTC
Copy link
Copy Markdown
Contributor

@WangXiangUSTC WangXiangUSTC commented Feb 5, 2020

What is changed, added or deleted?

Now we have too many tools, users may don't know how to choose. So we need add a guide, tells users every tool's usage scenario.

Which TiDB version(s) does your changes apply to?

  • All active versions: dev, v3.0, v2.1, v3.1
  • dev (the latest development version)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)
  • v3.1 (TiDB 3.1 versions)
  • v4.0 (TiDB 4.0 versions)
  • All active and inactive versions
  • N/A (not applicable)

Note: If your changes apply to multiple TiDB versions, make sure you update the documents in the corresponding version folders such as "dev", "v3.0", "v2.1" and "v3.1" in this PR.

  • Updated one version first. Will update other versions after I get two LGTMs.

Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
@TomShawn TomShawn added the translation/doing This PR’s assignee is translating this PR. label Feb 6, 2020
@WangXiangUSTC
Copy link
Copy Markdown
Contributor Author

@GregoryIan all resolved, PTAL again

@IANTHEREAL
Copy link
Copy Markdown
Contributor

LGTM

@IANTHEREAL IANTHEREAL added the status/LGT1 Indicates that a PR has LGTM 1. label Feb 6, 2020
@lilin90 lilin90 requested a review from yikeke February 6, 2020 08:09
lichunzhu
lichunzhu previously approved these changes Feb 6, 2020
Copy link
Copy Markdown
Contributor

@lichunzhu lichunzhu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lichunzhu lichunzhu added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Feb 6, 2020
@lichunzhu lichunzhu dismissed their stale review February 6, 2020 08:19

Give approval by mistask

Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
Comment thread dev/reference/tools/guide.md Outdated
@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Feb 6, 2020

I made a commit to refine the doc. Preview here: https://github.com/pingcap/docs-cn/blob/a60684586926f195b801d7eb02e155679685b322/dev/reference/tools/use-guide.md

PTAL @WangXiangUSTC

NOTE: Because #2184 is still under review, a dead link appears because of my new commit. We should merge this PR after #2184 is merged. I'll push forward its progress as quickly as possible.

Comment thread dev/reference/tools/use-guide.md Outdated
Comment thread dev/reference/tools/use-guide.md Outdated
@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Feb 11, 2020

#2184 is merged. Please update the other versions and we can merge this PR~ @WangXiangUSTC

@WangXiangUSTC
Copy link
Copy Markdown
Contributor Author

@yikeke v2.1, v3.0 and v3.1 is updated, PTAL again

Comment thread dev/reference/tools/use-guide.md Outdated
Comment thread dev/reference/tools/use-guide.md Outdated
Comment thread v3.1/reference/tools/use-guide.md Outdated
Comment thread v3.1/reference/tools/use-guide.md Outdated
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yikeke yikeke added the status/can-merge Indicates a PR has been approved by a committer. label Feb 12, 2020
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Feb 12, 2020

/run-all-tests

@sre-bot sre-bot merged commit 1a5d1fc into pingcap:master Feb 12, 2020
@WangXiangUSTC WangXiangUSTC deleted the xiang/tools_guide branch February 12, 2020 04:21
@WangXiangUSTC
Copy link
Copy Markdown
Contributor Author

thanks @yikeke

Comment thread dev/TOC.md
@lilin90 lilin90 added the size/large Changes of a large size. label Feb 17, 2020
@lilin90
Copy link
Copy Markdown
Member

lilin90 commented Feb 18, 2020

@toutdesuite Please also refer to related changes in #2244 when you deal with the English version. Pay attention to the new file name. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/large Changes of a large size. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants