Batch fix doc issues in tiup docs #6042

TomShawn · 2021-04-15T08:14:11Z

What is changed, added or deleted? (Required)

Batch fix typos in tiup docs

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

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

This PR is translated from:
Other reference link(s): tiup: refactor tiup reference #4868 mirrir -> mirror docs#5292

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

tiup/tiup-command-mirror-genkey.md

tiup/tiup-command-list.md

TomShawn · 2021-04-20T06:53:52Z

/cc @qiancai @lucklove
/translation no-need
/label needs-cherry-pick-5.0
/label needs-cherry-pick-4.0

lucklove · 2021-04-20T08:53:13Z

/lgtm

tiup/tiup-command-list.md

tiup/tiup-command-mirror-clone.md

qiancai · 2021-04-20T07:35:02Z

tiup/tiup-command-mirror-modify.md

+### --standalone

-该组件是否可独立运行。本参数目前尚未启用。
+- 该组件是否可独立运行。本参数目前尚未启用。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。


@lucklove, 请问如果此参数尚未启用，对用户就没有什么意义，所以暂时不需要提前放到用户文档里？

qiancai · 2021-04-20T07:37:03Z

tiup/tiup-command-mirror-publish.md

+### --standalone

-该组件是否可独立运行。该参数目前尚未启用。
+- 该组件是否可独立运行。该参数目前尚未启用。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。


@lucklove , 请问如果此参数尚未启用，对用户就没有什么意义，所以暂时不需要提前放到用户文档里？

qiancai · 2021-04-20T07:51:39Z

tiup/tiup-component-cluster-deploy.md

-在组件二进制文件部署之后，会对 TiDB，TiKV 和 PD 组件执行配置检查，检查方式为 `<binary> --config-check <config-file>`，其中 `<bianry>` 为部署的二进制文件的路径，`<config-file>` 为根据用户配置生成的配置文件。
+- 在组件二进制文件部署之后，会对 TiDB，TiKV 和 PD 组件执行配置检查，检查方式为 `<binary> --config-check <config-file>`，其中 `<binary>` 为部署的二进制文件的路径，`<config-file>` 为根据用户配置生成的配置文件。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。

 如果想要跳过该项检查，可以使用该选项。


如果把这句话挪到第一个item 后面, 是否也可以呢？
“如果想要跳过该项检查，可以使用该选项。”

qiancai · 2021-04-20T07:54:25Z

tiup/tiup-component-cluster-destroy.md

-在某些情况下，有可能集群中的某些节点已经宕机，导致无法通过 SSH 连接到节点进行操作，这个时候可以通过 `--force` 选项忽略这些错误。
+- 在某些情况下，有可能集群中的某些节点已经宕机，导致无法通过 SSH 连接到节点进行操作，这个时候可以通过 `--force` 选项忽略这些错误。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。

 ### --retain-node-data（StringArray，默认为空）


Should the info here about the data type and default value be updated to an unordered list too?

There are hundreds of similar modifications to make in the TiUP docs and the workload can be huge. This PR only updates/refines a part of them. Other unrefined titles will be refined in upcoming PRs.

tiup/tiup-component-dm.md

qiancai · 2021-04-20T10:31:51Z

tiup/tiup-component-cluster-clean.md

-该选项开启日志清理，若不指定该选项，也不指定 `--all`，则不清理日志。
+- 该选项开启日志清理，若不指定该选项，也不指定 `--all`，则不清理日志。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。

 ### --ignore-node（StringArray，默认为空）


Should the info here about the data type and default value be updated to an unordered list too?

There are hundreds of similar modifications to make in the TiUP docs and the workload can be huge. This PR only updates/refines a part of them. Other unrefined titles will be refined in upcoming PRs.

Co-authored-by: Grace Cai <qqzczy@126.com>

tiup/tiup-component-dm.md

TomShawn · 2021-04-21T08:38:01Z

@qiancai All your comments above are addressed in 7a80678. PTAL again. Thanks!

ti-chi-bot · 2021-04-26T02:59:30Z

@qiancai: /lgtm is only allowed for the reviewers in list.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

qiancai · 2021-04-26T02:59:45Z

/lgtm

ti-chi-bot · 2021-04-26T02:59:47Z

@qiancai: /lgtm is only allowed for the reviewers in list.

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

ti-chi-bot · 2021-04-26T03:06:17Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

CharLotteiu
lucklove

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

TomShawn · 2021-04-26T03:06:20Z

/label require-LGT1

TomShawn · 2021-04-26T03:07:29Z

/remove-translation no-need
/translation doing
/assign

TomShawn · 2021-04-26T03:08:49Z

/merge

ti-chi-bot · 2021-04-26T03:08:51Z

This pull request has been accepted and is ready to merge.

Commit hash: da0123d

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2021-04-26T03:10:38Z

cherry pick to release-4.0 in PR #6165

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2021-04-26T03:11:20Z

cherry pick to release-5.0 in PR #6166

Batch fix typos in tiup docs

88e1c5f

ti-chi-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 15, 2021

remove title for boolean false

201af2d

ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 20, 2021

remove

899ca4b

TomShawn commented Apr 20, 2021

View reviewed changes

tiup/tiup-command-mirror-genkey.md Outdated Show resolved Hide resolved

Update tiup/tiup-command-mirror-genkey.md

9a863e0

TomShawn commented Apr 20, 2021

View reviewed changes

tiup/tiup-command-list.md Show resolved Hide resolved

Update tiup/tiup-command-list.md

550ad79

ti-chi-bot requested review from lucklove and qiancai April 20, 2021 06:53

ti-chi-bot added translation/no-need No need to translate this PR. needs-cherry-pick-5.0 and removed missing-translation-status This PR does not have translation status info. labels Apr 20, 2021

TomShawn marked this pull request as ready for review April 20, 2021 06:53

ti-chi-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 20, 2021

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Apr 20, 2021

qiancai reviewed Apr 20, 2021

View reviewed changes

Apply suggestions from code review

5cd6e97

Co-authored-by: Grace Cai <qqzczy@126.com>

TomShawn commented Apr 20, 2021

View reviewed changes

tiup/tiup-component-dm.md Outdated Show resolved Hide resolved

TomShawn added 3 commits April 20, 2021 19:14

Update tiup/tiup-component-dm.md

7c33457

fix a typo

970653f

address comments from qiancai

7a80678

qiancai approved these changes Apr 26, 2021

View reviewed changes

CharLotteiu approved these changes Apr 26, 2021

View reviewed changes

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Apr 26, 2021

ti-chi-bot added the require-LGT1 Indicates that the PR requires an LGTM. label Apr 26, 2021

ti-chi-bot assigned TomShawn Apr 26, 2021

ti-chi-bot added translation/doing This PR’s assignee is translating this PR. and removed translation/no-need No need to translate this PR. labels Apr 26, 2021

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 26, 2021

ti-chi-bot merged commit 3e454f1 into pingcap:master Apr 26, 2021

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Apr 26, 2021

cherry pick pingcap#6042 to release-4.0

ff7c5ff

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Apr 26, 2021

Batch fix doc issues in tiup docs (#6042) #6165

Merged

10 tasks

TomShawn deleted the fix-typo-tiup-multiple branch April 26, 2021 03:10

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Apr 26, 2021

cherry pick pingcap#6042 to release-5.0

79018a1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Apr 26, 2021

Batch fix doc issues in tiup docs (#6042) #6166

Merged

10 tasks

ti-chi-bot pushed a commit that referenced this pull request Apr 26, 2021

Batch fix doc issues in tiup docs (#6042) (#6166)

166b58e

ti-chi-bot pushed a commit that referenced this pull request Apr 26, 2021

Batch fix doc issues in tiup docs (#6042) (#6165)

1ce22f0

TomShawn added requires-followup This PR requires a follow-up task after being merged. translation/no-need No need to translate this PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jul 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Batch fix doc issues in tiup docs #6042

Batch fix doc issues in tiup docs #6042

TomShawn commented Apr 15, 2021 •

edited

Loading

TomShawn commented Apr 20, 2021

lucklove commented Apr 20, 2021

qiancai Apr 20, 2021

lucklove Apr 21, 2021

qiancai Apr 20, 2021

qiancai Apr 20, 2021

qiancai Apr 20, 2021

TomShawn Apr 21, 2021

qiancai Apr 20, 2021

TomShawn Apr 21, 2021 •

edited

Loading

TomShawn commented Apr 21, 2021

ti-chi-bot commented Apr 26, 2021

qiancai commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

TomShawn commented Apr 26, 2021

TomShawn commented Apr 26, 2021

TomShawn commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

ti-srebot commented Apr 26, 2021

ti-srebot commented Apr 26, 2021

Batch fix doc issues in tiup docs #6042

Batch fix doc issues in tiup docs #6042

Conversation

TomShawn commented Apr 15, 2021 • edited Loading

What is changed, added or deleted? (Required)

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

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

Do your changes match any of the following descriptions?

TomShawn commented Apr 20, 2021

lucklove commented Apr 20, 2021

qiancai Apr 20, 2021

Choose a reason for hiding this comment

lucklove Apr 21, 2021

Choose a reason for hiding this comment

qiancai Apr 20, 2021

Choose a reason for hiding this comment

qiancai Apr 20, 2021

Choose a reason for hiding this comment

qiancai Apr 20, 2021

Choose a reason for hiding this comment

TomShawn Apr 21, 2021

Choose a reason for hiding this comment

qiancai Apr 20, 2021

Choose a reason for hiding this comment

TomShawn Apr 21, 2021 • edited Loading

Choose a reason for hiding this comment

TomShawn commented Apr 21, 2021

ti-chi-bot commented Apr 26, 2021

qiancai commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

TomShawn commented Apr 26, 2021

TomShawn commented Apr 26, 2021

TomShawn commented Apr 26, 2021

ti-chi-bot commented Apr 26, 2021

ti-srebot commented Apr 26, 2021

ti-srebot commented Apr 26, 2021

TomShawn commented Apr 15, 2021 •

edited

Loading

TomShawn Apr 21, 2021 •

edited

Loading