From 1f6f13be1a25a5f16be0867cfdc0854d0349c307 Mon Sep 17 00:00:00 2001 From: qiancai Date: Mon, 19 Apr 2021 13:36:13 +0800 Subject: [PATCH] TiUP: Fix broken links and errors --- tiup/tiup-component-cluster-start.md | 6 +++--- tiup/tiup-component-cluster-stop.md | 10 +++++----- tiup/tiup-component-dm-display.md | 6 +++--- tiup/tiup-component-dm-upgrade.md | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/tiup/tiup-component-cluster-start.md b/tiup/tiup-component-cluster-start.md index de41844f773f9..60c2299438af6 100644 --- a/tiup/tiup-component-cluster-start.md +++ b/tiup/tiup-component-cluster-start.md @@ -12,7 +12,7 @@ The `tiup cluster start` command is used to start all services or some services tiup cluster start [flags] ``` -`` is the name of the cluster to operate on. If you forget the cluster name, check it using the [cluster list](/tiup/tiup-component-cluster-list.md) command. +`` is the name of the cluster to operate on. If you forget the cluster name, you can check it using the [`tiup cluster list`](/tiup/tiup-component-cluster-list.md) command. ## Options @@ -24,7 +24,7 @@ tiup cluster start [flags] > **Note:** > -> If the `-R, --role` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are restarted. +> If the `-R, --role` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are started. ### -R, --role @@ -34,7 +34,7 @@ tiup cluster start [flags] > **Note:** > -> If the `-N, --node` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are restarted. +> If the `-N, --node` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are started. ### -h, --help diff --git a/tiup/tiup-component-cluster-stop.md b/tiup/tiup-component-cluster-stop.md index a7bbe4510114a..c208b82feddde 100644 --- a/tiup/tiup-component-cluster-stop.md +++ b/tiup/tiup-component-cluster-stop.md @@ -16,29 +16,29 @@ The `tiup cluster stop` command is used to stop all services or some services of tiup cluster stop [flags] ``` -`` is the name of the cluster to operate on. If you forget the cluster name, check it with the [cluster list](/tiup/tiup-component-cluster-list.md) command. +`` is the name of the cluster to operate on. If you forget the cluster name, you can check it using the [`tiup cluster list`](/tiup/tiup-component-cluster-list.md) command. ## Options ### -N, --node -- Specifies the nodes to be stoped. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. +- Specifies the nodes to be stopped. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. - Data type: `STRING` - Default: []. If this option is not specified in the command, the command stops all the nodes. > **Note:** > -> If the `-R, --role` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are restarted. +> If the `-R, --role` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are stopped. ### -R, --role -- Specifies the roles of nodes to be stoped. The value of this option is a comma-separated list of the roles of the nodes. You can get the roles of the nodes from the second column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. +- Specifies the roles of nodes to be stopped. The value of this option is a comma-separated list of the roles of the nodes. You can get the roles of the nodes from the second column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. - Data type: `STRING` - Default: []. If this option is not specified in the command, the command stops all the roles. > **Note:** > -> If the `-N, --node` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are restarted. +> If the `-N, --node` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are stopped. ### -h, --help diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 1945ae76a8476..dbc6e403a2595 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -12,7 +12,7 @@ If you want to check the operational status of each component in a DM cluster, i tiup dm display [flags] ``` -`` is the name of the cluster to be operated. If you forget the cluster name, you can use the `[tiup dm list](/tiup/tiup-component-dm-list.md)` command to check it. +`` is the name of the cluster to be operated. If you forget the cluster name, you can check it using the [`tiup dm list`](/tiup/tiup-component-dm-list.md) command. ## Options @@ -24,7 +24,7 @@ tiup dm display [flags] > **Note:** > -> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles is queried. +> If `-R, --role` is also specified, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are queried. ### -R, --role @@ -34,7 +34,7 @@ tiup dm display [flags] > **Note:** > -> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles is queried. +> If `-N, --node` is also specified, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are queried. ### -h, --help diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index 31bcb8aa2e90b..3540d619eb9eb 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -12,7 +12,7 @@ The `tiup dm upgrade` command is used to upgrade a specified cluster to a specif tiup dm upgrade [flags] ``` -- `` is the name of the cluster to be operated on. If you forget the cluster name, you can use the `[tiup dm list](/tiup/tiup-component-dm-list.md)` command to check it. +- `` is the name of the cluster to be operated on. If you forget the cluster name, you can check it using the [`tiup dm list`](/tiup/tiup-component-dm-list.md) command. - `` is the target version to be upgraded to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. ## Options