Skip to content

Commit

Permalink
Batch add anchor links in TiUP command docs (pingcap#6242)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joyinqin authored May 12, 2021
1 parent 4f9901b commit 24edcf3
Show file tree
Hide file tree
Showing 68 changed files with 156 additions and 20 deletions.
2 changes: 2 additions & 0 deletions tiup/tiup-command-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ tiup clean [name] [flags]
```
Clean instance of `%s`, directory: %s
```

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ source $HOME/.bash_profile
```shell
tiup completion zsh > "${fpath[1]}/_tiup"
```

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ tiup env [name1...N]
- 若指定了 `[name1...N]`,则按顺序输出 "{value}" 列表

以上输出中若 `value` 为空则代表未设置环境变量的值,此时 TiUP 会使用默认值。

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ tiup help [command]
## 输出

`[command]` 或 TiUP 的帮助信息。

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ tiup install <component1>[:version] [component2...N] [flags]
- 正常情况下输出组件的下载信息
- 若组件不存在则报错 `The component "%s" not found`
- 若版本不存在则报错 `version %s not supported by component %s`

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ tiup list [component] [flags]
- 若指定 `[component]`
-`[component]` 存在:输出 `版本 (Version)``是否已安装 (Installed)``发布时间 (Release)``支持的平台 (Platforms)` 构成的版本信息列表
-`[component]` 不存在:报错 `failed to fetch component: unknown component`

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,5 @@ tiup mirror clone <target-dir> [global version] [flags]
### --{component}(strings,默认为空)

指定要克隆的 `{component}` 组件的版本列表。`{component}` 为组件名,可选的组件名可执行 [`tiup list --all`](/tiup/tiup-command-list.md) 查看。

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-genkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ tiup mirror genkey [flags]
- 若指定 `-p/--public`
- 若指定的密钥不存在:`Error: open ${TIUP_HOME}/keys/{name}.json: no such file or directory`
- 若指定的密钥存在:输出该密钥对应的公钥内容

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ tiup mirror grant <id> [flags]
- 若执行成功:无输出
- 若管理员 ID 重复:`Error: owner %s exists`
- 若密钥已被其他管理员使用:`Error: key %s exists`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ tiup mirror init <path> [flags]
- 若成功:无输出
-`<path>` 不为空:`Error: the target path '%s' is not an empty directory`
-`<path>` 不是目录:`Error: fdopendir: not a directory`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ tiup mirror merge <mirror-dir-1> [mirror-dir-N] [flags]

- 成功:无输出
- 当前镜像缺失目标镜像某个组件的管理员,或 `${TIUP_HOME}/keys` 缺失该管理员的私钥:`Error: missing owner keys for owner %s on component %s`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,5 @@ tiup mirror modify <component>[:version] [flags]
- 若该组件管理员无权修改目标组件:
- 若使用远程镜像:`Error: The server refused, make sure you have access to this component`
- 若使用本地镜像:`Error: the signature is not correct`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,5 @@ tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
- 若该组件管理员无权修改目标组件:
- 若使用远程镜像:`Error: The server refused, make sure you have access to this component`
- 若使用本地镜像:`Error: the signature is not correct`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@ tiup mirror rotate [flags]
## 输出

- 各个镜像管理员当前的签名状态

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ tiup mirror set <mirror-addr> -r /path/to/local/root.json
## 输出


[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-command-mirror-sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,6 @@ tiup mirror sign <manifest-file> [flags]

- 成功:无输出
- 文件已被指定的 key 签名过:`Error: this manifest file has already been signed by specified key`
- 文件不是合法的 manifest:`Error: unmarshal manifest: %s`
- 文件不是合法的 manifest:`Error: unmarshal manifest: %s`

[<< 返回上一页 - TiUP Mirror 命令清单](/tiup/tiup-command-mirror.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@ tiup mirror <command> [flags]
- [rotate](/tiup/tiup-command-mirror-rotate.md): 更新当前镜像中的根证书
- [clone](/tiup/tiup-command-mirror-clone.md): 从已有镜像克隆一个新的镜像
- [merge](/tiup/tiup-command-mirror-merge.md): 合并镜像

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-command-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,6 @@ tiup status [flags]
- Created Time: 启动时间
- Directory: 数据目录
- Binary: 二进制文件路径
- Args: 启动参数
- Args: 启动参数

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-command-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,6 @@ tiup telemetry <command>

### disable

命令 `tiup telemetry disable` 停用遥测。
命令 `tiup telemetry disable` 停用遥测。

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-command-uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,6 @@ tiup uninstall <component1>:<version> [component2...N] [flags]
## 输出

- 正常退出:`Uninstalled component "%s" successfully!`
- 若未指定 `<version>` 也未指定 `--all`:报错 `Use "tiup uninstall tidbx --all" if you want to remove all versions.`
- 若未指定 `<version>` 也未指定 `--all`:报错 `Use "tiup uninstall tidbx --all" if you want to remove all versions.`

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-command-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,5 @@ tiup update [component1][:version] [component2..N] [flags]

- 升级成功:`Updated successfully!`
- 目标版本不存在:`Error: version %s not supported by component %s`

[<< 返回上一页 - TiUP 命令清单](/tiup/tiup-reference.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,6 @@ tiup cluster audit [audit-id] [flags]
- 若不指定 `[audit-id]` 则输出含有以下字段的表格:
- ID:该条记录对应的 audit-id
- Time:该条记录对应的命令执行时间
- Command:该条记录对应的命令
- Command:该条记录对应的命令

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,5 @@ tiup cluster check <topology.yml | cluster-name> [flags]
- Check:检查项
- Result:检查结果(Pass/Warn/Fail)
- Message:结果描述

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ tiup cluster clean <cluster-name> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,5 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
## 输出

部署日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,5 @@ tiup cluster destroy <cluster-name> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,5 @@ tiup cluster disable <cluster-name> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,6 @@ tiup cluster display <cluster-name> [flags]
- OS/Arch:该节点的操作系统和机器架构
- Status:该节点服务当前的状态
- Data Dir:服务的数据目录,`-` 表示没有数据目录
- Deploy Dir:服务的部署目录
- Deploy Dir:服务的部署目录

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-edit-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ tiup cluster edit-config <cluster-name> [flags]

- 正常情况无输出
- 若修改了不能修改的字段,则保存文件时报错并提示用户重新编辑,不能修改的字段参考[拓扑文件](/tiup/tiup-cluster-topology-reference.md)中的相关描述

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,5 @@ tiup cluster enable <cluster-name> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ tiup cluster help [command] [flags]
## 输出

`[command]` 或 tiup-cluster 的帮助信息。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ tiup cluster import [flags]
## 输出

导入过程的日志信息。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,5 @@ tiup cluster list [flags]
- Version:集群版本
- Path:集群部署数据在中控机上的路径
- PrivateKey:连接集群的私钥所在路径

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,5 @@ tiup cluster patch <cluster-name> <package-path> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ tiup cluster prune <cluster-name> [flags]
## 输出

清理过程的日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-reload.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,5 @@ tiup cluster reload <cluster-name> [flags]
## 输出

tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,6 @@ tiup cluster rename <old-cluster-name> <new-cluster-name> [flags]

## 输出

tiup-cluster 的执行日志。
tiup-cluster 的执行日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-replay.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ tiup cluster replay <audit-id> [flags]
## 输出

`<audit-id>` 对应的命令的输出。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,6 @@ tiup cluster restart <cluster-name> [flags]

## 输出

重启服务的日志。
重启服务的日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-scale-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,5 @@ tiup cluster scale-in <cluster-name> [flags]
## 输出

缩容日志

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,5 @@ tiup cluster scale-out <cluster-name> <topology.yaml> [flags]
## 输出

扩容日志

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,6 @@ tiup cluster start <cluster-name> [flags]

## 输出

启动日志。
启动日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-cluster-stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,6 @@ tiup cluster stop <cluster-name> [flags]

## 输出

停止服务的日志。
停止服务的日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ tiup cluster template [flags]
## 输出

根据指定选项输出拓扑模版,可重定向到拓扑文件中用于部署。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@ tiup cluster upgrade <cluster-name> <version> [flags]
## 输出

升级服务的日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,5 @@ tiup cluster [command] [flags]
- [enable](/tiup/tiup-component-cluster-enable.md):开启指定集群或服务开机自启动
- [disable](/tiup/tiup-component-cluster-disable.md):关闭指定集群或服务开机自启动
- [help](/tiup/tiup-component-cluster-help.md):输出帮助信息

[<< 返回上一页 - TiUP 组件清单](/tiup/tiup-reference.md#组件清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-dm-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ tiup dm audit [audit-id] [flags]
- ID:该条记录对应的 audit-id
- Time:该条记录对应的命令执行时间
- Command:该条记录对应的命令

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-dm-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,6 @@ tiup dm deploy <cluster-name> <version> <topology.yaml> [flags]

## 输出

部署日志。
部署日志。

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-dm-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ tiup dm destroy <cluster-name> [flags]

## 输出

tiup-dm 的执行日志。
tiup-dm 的执行日志。

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-dm-disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,5 @@ tiup dm disable <cluster-name> [flags]
## 输出

tiup-dm 的执行日志。

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
2 changes: 2 additions & 0 deletions tiup/tiup-component-dm-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,5 @@ tiup dm display <cluster-name> [flags]
- Status:该节点服务当前的状态
- Data Dir:服务的数据目录,`-` 表示没有数据目录
- Deploy Dir:服务的部署目录

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
4 changes: 3 additions & 1 deletion tiup/tiup-component-dm-edit-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,6 @@ tiup dm edit-config <cluster-name> [flags]
## 输出

- 正常情况无输出
- 若修改了不能修改的字段,则保存文件时报错并提示用户重新编辑,不能修改的字段参考[拓扑文件](/tiup/tiup-dm-topology-reference.md)中的相关描述
- 若修改了不能修改的字段,则保存文件时报错并提示用户重新编辑,不能修改的字段参考[拓扑文件](/tiup/tiup-dm-topology-reference.md)中的相关描述

[<< 返回上一页 - TiUP DM 命令清单](/tiup/tiup-component-dm.md#命令清单)
Loading

0 comments on commit 24edcf3

Please sign in to comment.