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.

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

dev/v3.0/v2.1: add a tip for binlogctl's usage #1415

Merged

Conversation

junlan-zhang
Copy link
Contributor

What is changed, added or deleted?

  • Add a tip for binlogctl's usage

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

pingcap/docs-cn#1663

Which version does your change affect?

dev, v3.0, v2.1

Checklist

  • Add a new file to TOC.md
  • No Tab spaces anywhere
  • Leave a blank line both before and after a code block
  • Keep the first level heading consistent with title in metadata
  • Use four spaces for each level of indentation except that in TOC.md

@WangXiangUSTC
Copy link
Contributor

LGTM

@junlan-zhang
Copy link
Contributor Author

Please help review this PR, Thanks a lot! @TomShawn

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.

LGTM

@@ -100,7 +100,7 @@ Command example:
bin/binlogctl -pd-urls=http://127.0.0.1:2379 -cmd update-pump -node-id ip-127-0-0-1:8250 -state paused
```

This command modifies the state of Pump or Drainer saved in the Placement Driver (PD).
This command modifies the state of Pump or Drainer saved in the Placement Driver (PD) and is only used if Pump or Drainer service fails to function properly.
Copy link
Contributor

Choose a reason for hiding this comment

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

From the context, the reader must use this command very carefully. This information would be better understood if it is in the note format and active voice is used.

Suggested change
This command modifies the state of Pump or Drainer saved in the Placement Driver (PD) and is only used if Pump or Drainer service fails to function properly.
> **Note:**
>
> This command modifies the state of Pump or Drainer saved in the Placement Driver (PD).
> Use this command **only** when the Pump or Drainer service fails to function properly.

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.

Please also apply the change to v2.1 and dev.

@junlan-zhang
Copy link
Contributor Author

PTAL :) @TomShawn

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.

LGTM

@TomShawn TomShawn merged commit 0e4de6f into pingcap:master Aug 6, 2019
@yikeke yikeke added the translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. label Aug 7, 2019
@junlan-zhang junlan-zhang deleted the tools-add-a-tip-for-binlogctl's-usage branch October 8, 2019 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants