Skip to content

tools: update user guide#2098

Merged
sre-bot merged 13 commits into
pingcap:masterfrom
yikeke:update-tools-user-guide
Apr 1, 2020
Merged

tools: update user guide#2098
sre-bot merged 13 commits into
pingcap:masterfrom
yikeke:update-tools-user-guide

Conversation

@yikeke
Copy link
Copy Markdown
Contributor

@yikeke yikeke commented Mar 25, 2020

What is changed, added or deleted? (Required)

Update tools user guide according to the latest changes made by Shenli

Note: The English version of Tools User Guide doc is inconsistent from the Chinese version because of this PR. This is known by R&Ds so the subsequent changes to the two docs should be on their own.

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

  • master (the latest development version, including v4.0 changes for now)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

**NOTE: I will delete inapplicable content in the 3.1 and 3.0 versions after the cherry-picking. **

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-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.

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

@yikeke yikeke requested review from IANTHEREAL and lilin90 March 25, 2020 09:39
@yikeke yikeke added the translation/no-need No need to translate this PR. label Mar 25, 2020
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Mar 25, 2020

I will delete inapplicable content in the 3.1 and 3.0 versions after the cherry-picking. FYI.

@lilin90
Copy link
Copy Markdown
Member

lilin90 commented Mar 25, 2020

@dcalvin @anotherrachel FYI.

Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@yikeke yikeke requested a review from WangXiangUSTC March 26, 2020 03:09
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Mar 26, 2020

PTAL @GregoryIan @WangXiangUSTC

Copy link
Copy Markdown
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

Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
### Incremental data import tools

The following are the basics of Loader:
#### TiDB Data Migration
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In fact DM can backup and restore the full data and replicate incremental data from MySQL, should we add a new category for it?

Copy link
Copy Markdown
Contributor Author

@yikeke yikeke Mar 26, 2020

Choose a reason for hiding this comment

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

What do you suggest? @GregoryIan @shenli

Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Co-Authored-By: WangXiangUSTC <wx347249478@gmail.com>
Comment thread reference/tools/user-guide.md Outdated
@yikeke yikeke requested a review from shenli March 26, 2020 07:36
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
- TiDB Incremental Data Migration:
- TiDB Binlog -> CDC

## Full-path data migration solution for TiDB 3.0, 3.1 and 4.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems this section's most content is duplicate with Recommended tools for TiDB versions

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It seems that Full-path data migration solution for TiDB 3.0, 3.1 and 4.0 section gives a more detailed description than Recommended tools for TiDB versions. Can we just delete the Recommended tools for TiDB versions section? @WangXiangUSTC

What do you suggest? @GregoryIan @shenli

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we can merge this PR first and then invite some users to get feedback. We could refine this document based on the feedbacks.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Okay, ready for merge now.

Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Comment thread reference/tools/user-guide.md Outdated
Co-Authored-By: Ian <ArGregoryIan@gmail.com>
Copy link
Copy Markdown
Contributor Author

@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

Copy link
Copy Markdown
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.

LGTM

@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Apr 1, 2020

/merge

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

sre-bot commented Apr 1, 2020

/run-all-tests

@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 1, 2020

@yikeke merge failed.

@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Apr 1, 2020

/merge

@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 1, 2020

/run-all-tests

@sre-bot sre-bot merged commit eff6777 into pingcap:master Apr 1, 2020
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Apr 1, 2020

/run-cherry-picker

@yikeke yikeke deleted the update-tools-user-guide branch April 1, 2020 13:25
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 1, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot sre-bot mentioned this pull request Apr 1, 2020
4 tasks
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 1, 2020

cherry pick to release-3.0 in PR #2146

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 1, 2020
@sre-bot sre-bot mentioned this pull request Apr 1, 2020
4 tasks
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 1, 2020

cherry pick to release-3.1 in PR #2147

lilin90 pushed a commit that referenced this pull request Apr 2, 2020
* cherry pick #2098 to release-3.0

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

* delete inapplicable content; fix two links

* fix a link

* Update reference/tools/user-guide.md

Co-Authored-By: WangXiangUSTC <wx347249478@gmail.com>

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: WangXiangUSTC <wx347249478@gmail.com>
lilin90 pushed a commit that referenced this pull request Apr 2, 2020
* tools: update user guide (#2098)

* Delete inapplication content

* Fix the ticdc dead link

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/can-merge Indicates a PR has been approved by a committer. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants