Skip to content

Commit

Permalink
TiUP: Fix broken links and errors (#5385) (#5390)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-srebot authored Apr 19, 2021
1 parent df62106 commit e7197d3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions tiup/tiup-component-cluster-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `tiup cluster start` command is used to start all services or some services
tiup cluster start <cluster-name> [flags]
```

`<cluster-name>` 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.
`<cluster-name>` 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

Expand All @@ -24,7 +24,7 @@ tiup cluster start <cluster-name> [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

Expand All @@ -34,7 +34,7 @@ tiup cluster start <cluster-name> [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

Expand Down
10 changes: 5 additions & 5 deletions tiup/tiup-component-cluster-stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,29 @@ The `tiup cluster stop` command is used to stop all services or some services of
tiup cluster stop <cluster-name> [flags]
```

`<cluster-name>` 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.
`<cluster-name>` 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

Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-component-dm-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you want to check the operational status of each component in a DM cluster, i
tiup dm display <cluster-name> [flags]
```

`<cluster-name>` 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.
`<cluster-name>` 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

Expand All @@ -24,7 +24,7 @@ tiup dm display <cluster-name> [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

Expand All @@ -34,7 +34,7 @@ tiup dm display <cluster-name> [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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `tiup dm upgrade` command is used to upgrade a specified cluster to a specif
tiup dm upgrade <cluster-name> <version> [flags]
```

- `<cluster-name>` 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.
- `<cluster-name>` 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.
- `<version>` 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
Expand Down

0 comments on commit e7197d3

Please sign in to comment.