Skip to content

Commit 94299ed

Browse files
yikekesre-bot
authored andcommitted
get-started: fix some descriptions and typos in tiup quick start doc (pingcap#2813)
* get-started: fix some descriptions and typos in tiup quick start doc * fix a grammar mistake * fix backticks format * change 登陆 -> 登录 * update tiup deploy
1 parent 174c640 commit 94299ed

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

how-to/deploy/orchestrated/tiup.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ Usage:
913913
Flags:
914914
-h, --help help for deploy
915915
-i, --identity_file string The path of the SSH identity file. If specified, public key authentication will be used.
916-
--user string The user name to login via SSH. The user must has root (or sudo) privilege. (default "root")
916+
--user string The user name to login via SSH. The user must have root (or sudo) privilege. (default "root")
917917
-y, --yes Skip confirming the topology
918918
919919
# Usage 展示执行命令样例,<> 为必填项
@@ -1029,7 +1029,7 @@ ID Role Host Ports
10291029
tiup cluster start tidb-test
10301030
```
10311031
1032-
预期结果输出 `Started cluster tidb-test successfully` 标志启动成功。
1032+
预期结果输出 ```Started cluster `tidb-test` successfully``` 标志启动成功。
10331033
10341034
## 6. 验证集群运行状态
10351035
@@ -1068,7 +1068,7 @@ ID Role Host Ports Status
10681068
10691069
#### 查看 TiDB Dashboard 检查 TiDB Cluster 状态
10701070
1071-
- 通过 `{pd-leader-ip}:2379/dashboard` 登录 TiDB Dashboard,登陆用户和口令为 TiDB 数据库 root 用户和口令,如果你修改过数据库的 root 密码,则以修改后的密码为准,默认密码为空。
1071+
- 通过 `{pd-leader-ip}:2379/dashboard` 登录 TiDB Dashboard,登录用户和口令为 TiDB 数据库 root 用户和口令,如果你修改过数据库的 root 密码,则以修改后的密码为准,默认密码为空。
10721072
10731073
![TiDB-Dashboard](/media/tiup/tidb-dashboard.png)
10741074
@@ -1192,7 +1192,7 @@ Bye
11921192
tiup cluster stop tidb-test
11931193
```
11941194
1195-
预期结果输出 `Stopped cluster tidb-test successfully` 标志关闭成功。
1195+
预期结果输出 ```Stopped cluster `tidb-test` successfully``` 标志关闭成功。
11961196
11971197
## 8. 销毁集群
11981198
@@ -1208,7 +1208,7 @@ tiup cluster stop tidb-test
12081208
tiup cluster destroy tidb-test
12091209
```
12101210
1211-
预期结果输出 `Destroy cluster tidb-test successfully` 标志销毁成功。
1211+
预期结果输出 ```Destroy cluster `tidb-test` successfully``` 标志销毁成功。
12121212
12131213
## 9. 常见部署问题
12141214
@@ -1370,9 +1370,9 @@ v4.0.0-rc 2020-04-09T00:10:32+08:00 linux/amd64,darwi
13701370
nightly 2020-04-10T08:42:23+08:00 darwin/amd64,linux/amd64
13711371
```
13721372
1373-
### 如何查看 TiUP 支持管理的组件和版本
1373+
### 如何查看 TiUP 支持管理的组件
13741374
1375-
执行如下命令查看 TiUP 支持管理的组件和版本
1375+
执行如下命令查看 TiUP 支持管理的组件
13761376
13771377
```shell
13781378
tiup list

how-to/get-started/quick-start-with-tidb.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ category: how-to
55

66
# 如何快速体验 TiDB 集群
77

8-
本文介绍如何快速体验 TiDB 分布式数据库。有以下 3 种体验方式供用户选择。
9-
108
> **警告:**
119
>
1210
> 对于生产环境,不要使用本文介绍的方式进行部署,而应使用 [TiUP 部署 TiDB 集群](/how-to/deploy/orchestrated/tiup.md)
1311
12+
本文介绍如何快速体验 TiDB 分布式数据库。有以下 3 种体验方式供用户选择。
13+
1414
- [第一种:使用 TiDB-Wasm 一键体验 TiDB 数据库](#第一种使用-tidb-wasm-一键体验-tidb-数据库)
1515
- [第二种:使用 TiUP Playground 快速部署本地测试环境](#第二种使用-tiup-playground-快速部署本地测试环境)
1616
- [第三种:使用 TiUP cluster 模拟单机下的准生产测试环境](#第三种使用-tiup-cluster-模拟单机下的准生产测试环境)
@@ -22,7 +22,7 @@ category: how-to
2222

2323
TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用。TiDB-Wasm 可直接进行 SQL 执行、兼容性验证等基本操作。
2424

25-
试用 TiDB-Wasm 直接点击网址:[https://tour.pingcap.com](https://tour.pingcap.com),之后会在内存中构建 TiDB 数据库,预计耗时 10 秒左右。
25+
直接点击网址试用 TiDB-Wasm<https://tour.pingcap.com>,之后会在内存中构建 TiDB 数据库,预计耗时 10 秒左右。
2626

2727
## 第二种:使用 TiUP Playground 快速部署本地测试环境
2828

@@ -77,15 +77,15 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用
7777
tiup playground
7878
```
7979

80-
- 也可以指定版本以及组件实例个数
80+
- 也可以指定 TiDB 版本以及各组件实例个数,命令类似于
8181

8282
{{< copyable "shell-regular" >}}
8383

8484
```shell
8585
tiup playground v4.0.0-rc --db 2 --pd 3 --kv 3 --monitor
8686
```
8787

88-
上述命令会在本地下载并启动一个 v4.0.0-rc 版本的集群,`--monitor` 表示同时部署监控组件。运行结果将显示集群的访问方式:
88+
上述命令会在本地下载并启动一个 `v4.0.0-rc` 版本的集群,`--monitor` 表示同时部署监控组件。运行结果将显示集群的访问方式:
8989

9090
```log
9191
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
@@ -145,7 +145,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用
145145
- 部署主机[关闭防火墙](/how-to/deploy/orchestrated/tiup.md#如何关闭部署机器的防火墙)或者开放 TiDB 集群的节点间所需端口
146146
- 目前 TiUP 仅支持在 x86_64 (AMD64) 架构上部署 TiDB 集群(TiUP 将在 4.0 GA 时支持在 ARM 架构上部署)
147147
- 在 AMD64 架构下,建议使用 CentOS 7.3 及以上版本 Linux 操作系统
148-
- 在 ARM 架构下,建议使用 CentOS 7.6 1810 版本 Linux 操作系操作步骤:
148+
- 在 ARM 架构下,建议使用 CentOS 7.6 1810 版本 Linux 操作系统
149149

150150
### 实施部署
151151

@@ -179,7 +179,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用
179179

180180
4. 由于模拟多机部署,需要通过 `root` 用户调大 sshd 服务的连接数限制:
181181

182-
1. 修改 /etc/ssh/sshd_config 将 `MaxSessions` 调至 20。
182+
1. 修改 `/etc/ssh/sshd_config``MaxSessions` 调至 20。
183183
2. 重启 sshd 服务:
184184

185185
{{< copyable "shell-regular" >}}
@@ -190,11 +190,11 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用
190190

191191
5. 创建并启动集群
192192

193-
按下面的配置模板,编辑配置文件,命名为 `topology.yaml`,其中:
193+
按下面的配置模板,编辑配置文件,命名为 `topo.yaml`,其中:
194194

195-
- `user: "tidb"` 表示通过 `tidb` 系统用户来做集群的内部管理(部署会自动创建),默认使用 22 端口通过 ssh 登陆目标机器
196-
- 设置 `replication.enable-placement-rules` 这个 PD 参数来确保 TiFlash 正常运行
197-
- host 改为本部署主机的 IP
195+
- `user: "tidb"`表示通过 `tidb` 系统用户(部署会自动创建)来做集群的内部管理,默认使用 22 端口通过 ssh 登录目标机器
196+
- `replication.enable-placement-rules`:设置这个 PD 参数来确保 TiFlash 正常运行
197+
- `host`:设置为本部署主机的 IP
198198

199199
配置模板如下:
200200

@@ -264,7 +264,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库,打开网页即可使用
264264
```
265265

266266
- 参数 `<cluster-name>` 表示设置集群名称
267-
- 参数 `<tidb-version>` 表示设置集群版本,可以通过 `tiup list tidb --refresh` 命令来选择当前支持部署的 TiDB 版本
267+
- 参数 `<tidb-version>` 表示设置集群版本,可以通过 `tiup list tidb --refresh` 命令来查看当前支持部署的 TiDB 版本
268268

269269
按照引导,输入”y”及 root 密码,来完成部署:
270270

0 commit comments

Comments
 (0)