Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 29 commits into from
Mar 17, 2020
Merged

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

merged 29 commits into from
Mar 17, 2020

Conversation

toutdesuite
Copy link
Contributor

@toutdesuite toutdesuite commented Feb 24, 2020 •
edited
Loading

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.

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

Important Notice:

If your changes apply to multiple TiDB documentation versions, to trigger the bot to cherry-pick this PR to other release branches, make sure you add labels such as:

  • needs-cherry-pick-3.0
  • needs-cherry-pick-3.1
  • needs-cherry-pick-2.1

@toutdesuite toutdesuite added the translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. label Feb 24, 2020
@toutdesuite
Copy link
Contributor Author

toutdesuite commented Feb 24, 2020 •
edited
Loading

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

@TomShawn
Copy link
Contributor

After this PR is given two LGTMs, I will commit to this PR according to the changes related to this document made in #2244.

WangXiangUSTC
WangXiangUSTC reviewed Feb 24, 2020
View reviewed changes
reference/tools/user-guide.md Outdated
- Applicable version of TiDB: All.
- Kubernetes: Not supported.

#### Incremental import tool TiDB Data Migration
Copy link
Contributor

Choose a reason for hiding this comment

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

DM support incremental and full data's export and import.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks a lot.

WangXiangUSTC
WangXiangUSTC reviewed Feb 24, 2020
View reviewed changes
Copy link
Contributor

@WangXiangUSTC WangXiangUSTC left a comment

Choose a reason for hiding this comment

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

rest LGTM

gregwebs
gregwebs reviewed Feb 24, 2020
View reviewed changes
reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated

### Data import tools

#### Full import tool loader (Stop maintenance, not recommended)
Copy link
Contributor

Choose a reason for hiding this comment

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

If Loader is deprecated, it is better to not lead with it, but instead lead with lightning and then mention that loader still exists but is deprecated.

Copy link
Contributor

Choose a reason for hiding this comment

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

We could consider even having a separate section for deprecated tools.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks a lot.

reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated Show resolved Hide resolved
@toutdesuite toutdesuite added v2.1 and removed v2.1 labels Feb 25, 2020
toutdesuite and others added 7 commits February 25, 2020 13:06
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
216b81e 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
383f5ba 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
e90dc0c 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
3e7d119 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
65e1fbc 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite @gregwebs
Update reference/tools/user-guide.md
db0995c 
Co-Authored-By: Greg Weber <greg@gregweber.info>
@toutdesuite
Resolve grammar error
1517983
TomShawn
TomShawn reviewed Mar 4, 2020
View reviewed changes
reference/tools/user-guide.md Outdated Show resolved Hide resolved
reference/tools/user-guide.md Outdated Show resolved Hide resolved
toutdesuite and others added 4 commits March 4, 2020 20:55
@toutdesuite @TomShawn
Update reference/tools/user-guide.md
f87b432 
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
@toutdesuite @TomShawn
Update reference/tools/user-guide.md
7bc7b1d 
Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>
@TomShawn
fix a broken link
847ca19
@toutdesuite
change the para order
f72bc1b
@toutdesuite
Copy link
Contributor Author

@lilin90 The lint failure is fixed.

yikeke
yikeke approved these changes Mar 17, 2020
View reviewed changes
Copy link
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

@TomShawn
Copy link
Contributor

TomShawn commented Mar 17, 2020 •
edited
Loading

@yikeke @toutdesuite #2244 is aligned in this PR, PTAL, thanks!

yikeke
yikeke reviewed Mar 17, 2020
View reviewed changes
Copy link
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.

Rest LGTM

TOC.md Outdated Show resolved Hide resolved
@toutdesuite @yikeke
Update TOC.md
c939cc7 
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
@yikeke yikeke added the status/can-merge Indicates a PR has been approved by a committer. label Mar 17, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Mar 17, 2020

/run-all-tests

@sre-bot sre-bot merged commit 5110f56 into pingcap:master Mar 17, 2020
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Mar 17, 2020
@toutdesuite @sre-bot
cherry pick pingcap#1860 to release-2.1
2397b66 
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot sre-bot mentioned this pull request Mar 17, 2020
Merged
1 task
@sre-bot
Copy link
Contributor

sre-bot commented Mar 17, 2020

cherry pick to release-2.1 in PR #2035

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Mar 17, 2020
@toutdesuite @sre-bot
cherry pick pingcap#1860 to release-3.0
3f86a8e 
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot sre-bot mentioned this pull request Mar 17, 2020
Merged
1 task
@sre-bot
Copy link
Contributor

sre-bot commented Mar 17, 2020

cherry pick to release-3.0 in PR #2036

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Mar 17, 2020
@toutdesuite @sre-bot
cherry pick pingcap#1860 to release-3.1
5bb4c17 
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot sre-bot mentioned this pull request Mar 17, 2020
Merged
1 task
@sre-bot
Copy link
Contributor

sre-bot commented Mar 17, 2020

cherry pick to release-3.1 in PR #2037

@TomShawn TomShawn mentioned this pull request Mar 17, 2020
Merged
4 tasks
@toutdesuite toutdesuite deleted the guide-for-choosing-TiDB-Ecosystem-Tools branch March 17, 2020 08:51
TomShawn added a commit that referenced this pull request Mar 17, 2020
@sre-bot @toutdesuite @TomShawn
tools: add a guide for choosing TiDB Ecosystem Tools (#1860) (#2035)
9e9bfe6 
* cherry pick #1860 to release-2.1

Signed-off-by: sre-bot <sre-bot@pingcap.com>

* resolve conflict and align #2243

Co-authored-by: toutdesuite <guizhiluo2014@163.com>
Co-authored-by: TomShawn <1135243111@qq.com>
sre-bot added a commit that referenced this pull request Mar 17, 2020
@sre-bot
tools: add a guide for choosing TiDB Ecosystem Tools (#1860) (#2037)
0f8b8b1 
Signed-off-by: sre-bot <sre-bot@pingcap.com>
TomShawn added a commit that referenced this pull request Mar 18, 2020
@sre-bot @toutdesuite @TomShawn
tools: add a guide for choosing TiDB Ecosystem Tools (#1860) (#2036)
8fc5299 
* cherry pick #1860 to release-3.0

Signed-off-by: sre-bot <sre-bot@pingcap.com>

* resolve conflicts

* update version numbers and replace links

Co-authored-by: toutdesuite <guizhiluo2014@163.com>
Co-authored-by: TomShawn <1135243111@qq.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@yikeke yikeke mentioned this pull request Mar 25, 2020
Merged
4 tasks
This was referenced Apr 1, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomShawn TomShawn TomShawn left review comments

@yikeke yikeke yikeke approved these changes

@lilin90 lilin90 lilin90 left review comments

@WangXiangUSTC WangXiangUSTC WangXiangUSTC left review comments

@gregwebs gregwebs gregwebs left review comments

Assignees
No one assigned
Labels
status/can-merge Indicates a PR has been approved by a committer. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@toutdesuite @TomShawn @sre-bot @gregwebs @WangXiangUSTC @lilin90 @yikeke