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

Update TiUP documentation from Special Week changes #3052

Merged
merged 14 commits into from
Jul 1, 2020
Merged

Update TiUP documentation from Special Week changes #3052

merged 14 commits into from
Jul 1, 2020

Conversation

yikeke
Copy link
Contributor

@yikeke yikeke commented Jun 28, 2020 •
edited
Loading

What is changed, added or deleted? (Required)

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

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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

@github-actions github-actions bot added translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. status/PTAL This PR is ready for reviewing. labels Jun 28, 2020
@yikeke yikeke added needs-cherry-pick-4.0 translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. and removed translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels Jun 28, 2020
@yikeke yikeke marked this pull request as ready for review June 28, 2020 09:59
@lonng lonng requested review from lucklove and removed request for lonng June 30, 2020 06:13
@ti-srebot
Copy link
Contributor

@lucklove, @TomShawn, PTAL.

TomShawn
TomShawn reviewed Jun 30, 2020
View reviewed changes
Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

Some minor edits on format and grammar

tiup/tiup-cluster.md Outdated Show resolved Hide resolved
tiup/tiup-component-management.md Outdated Show resolved Hide resolved
tiup/tiup-documentation-guide.md Show resolved Hide resolved
tiup/tiup-documentation-guide.md Outdated Show resolved Hide resolved
tiup/tiup-faq.md Show resolved Hide resolved
tiup/tiup-troubleshooting-guide.md Outdated Show resolved Hide resolved
tiup/tiup-troubleshooting-guide.md Outdated Show resolved Hide resolved
tiup/tiup-troubleshooting-guide.md Outdated Show resolved Hide resolved
tiup/tiup-troubleshooting-guide.md Outdated Show resolved Hide resolved
tiup/tiup-troubleshooting-guide.md Outdated Show resolved Hide resolved
lucklove
lucklove reviewed Jun 30, 2020
View reviewed changes
Copy link
Member

@lucklove lucklove 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

tiup/tiup-documentation-guide.md Outdated

- [tiup-playground](/tiup/tiup-playground.md): Introduce how to use the TiUP playground component to quickly build a local TiDB cluster for testing
- [tiup-cluster](/tiup/tiup-cluster.md): Introduce the usage and command-line flags of the TiUP cluster component, which is used to deploy and maintain a TiDB cluster for production
- [tiup-mirror](/tiup/tiup-mirror.md): Introduce how to use the TiUP mirror component to customize a local offline mirror
Copy link
Member

Choose a reason for hiding this comment

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

TiUP mirror is not a component anymore. It's a subcommand.
At previous it's a component, we use it as below:

tiup install mirrors
tiup mirrors clone

At this time, the mirrors component is deprecated and there is a mirror sub command:

tiup mirror clone xxx // no need to install

Copy link
Contributor Author

@yikeke yikeke Jul 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

The original Chinese text needs updates too. Can you file a PR to change the Chinese descriptions? I will align your changes later in the English version. @lucklove

FYI @lonng

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Confirmed with @lucklove, he will fix the deprecated content later in a new PR.

tiup/tiup-faq.md

## Are port and directory conflicts detected among different clusters?

If multiple different clusters are deployed by the same TiUP control machine, the port and directory conflicts among these clusters are detected during deployment and scaling. If the clusters are deployed by different TiUP control machines, conflict detection is not supported currently.
Copy link
Member

Choose a reason for hiding this comment

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

If the clusters are deployed by different TiUP control machines, conflict detection is not supported currently.

I think tiup cluster check can detect this...
The trade-off is that users need to run this command by themselves.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as #3052 (comment). Can you provide a Chinese version first?And I‘ll align it in the English version. @lucklove

FYI @lonng

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Confirmed with @lucklove, he will fix the deprecated content later in a new PR.

@yikeke
Copy link
Contributor Author

yikeke commented Jul 1, 2020

Most of your comments are accepted and applied. PTAL again @TomShawn

TomShawn
TomShawn reviewed Jul 1, 2020
View reviewed changes
Copy link
Contributor

@TomShawn TomShawn left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

tiup/tiup-component-management.md Outdated Show resolved Hide resolved
@yikeke yikeke added the requires-followup This PR requires a follow-up task after being merged. label Jul 1, 2020
@yikeke yikeke added status/LGT2 Indicates that a PR has LGTM 2. and removed status/PTAL This PR is ready for reviewing. labels Jul 1, 2020
@yikeke yikeke merged commit 9ddacd5 into master Jul 1, 2020
@yikeke yikeke deleted the update-tiup-docs branch July 1, 2020 09:03
ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Jul 1, 2020
@yikeke @ti-srebot
cherry pick pingcap#3052 to release-4.0
bdb9904 
Signed-off-by: ti-srebot <[email protected]>
@ti-srebot ti-srebot mentioned this pull request Jul 1, 2020
Merged
5 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-4.0 in PR #3103

ti-srebot added a commit that referenced this pull request Jul 1, 2020
@ti-srebot
Update TiUP documentation from Special Week changes (#3052) (#3103)
c6fd1e0 
Signed-off-by: ti-srebot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucklove lucklove lucklove left review comments

@TomShawn TomShawn TomShawn approved these changes

Assignees
No one assigned
Labels
requires-followup This PR requires a follow-up task after being merged. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. status/LGT2 Indicates that a PR has LGTM 2. 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.
4 participants
@yikeke @ti-srebot @lucklove @TomShawn