Skip to content

Commit 2a822b4

Browse files
laodouyalaodouya
authored andcommitted
Fix docs misunderstandings and links.
1 parent b4355b6 commit 2a822b4

File tree

10 files changed

+31
-15
lines changed

10 files changed

+31
-15
lines changed

docs/cql_account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ After get a wallet address, you may need to request PTC as above.
7070

7171
## Sub-command `generate` Complete Parameters
7272

73-
Also see [Common Parameters for Sub-commands](#common-parameters-for-sub-commands). We will not mention this again in the later sub-command introductions.
73+
Also see [Common Parameters for Sub-commands](cql_intro#common-parameters-for-sub-commands). We will not mention this again in the later sub-command introductions.
7474

7575
usage: cql generate [common params] [-source template_file] [-miner] [-private existing_private_key] [dest_path]
7676

docs/cql_db_access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Output:
1919

2020
co:4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5=>
2121

22-
Or access as `account2` if it has been granted access permission successfully:
22+
Or access as `account2` (Should been granted access permission and transfered deposit token to the database successfully in last section):
2323

2424
```bash
2525
cql console -config "account2/config.yaml" 'covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5'
@@ -55,7 +55,7 @@ Here is an example of using the interactive console:
5555

5656
The sub-command `console` also supports running `adapter` or `explorer` servers in the background. Check [Local Servers](#local-servers) for details.
5757

58-
usage: cql console [common params] [-command sqlcommand] [-file filename] [-out outputfile] [-no-rc true/false] [-single-transaction] [-variable variables] [-explorer explorer_addr] [-adapter adapter_addr] [dsn]
58+
usage: cql console [common params] [Console params] dsn
5959

6060
Console runs an interactive SQL console for CovenantSQL.
6161
e.g.

docs/cql_db_manage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
144144
-to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 \
145145
-perm '
146146
{
147-
"patterns": nil,
147+
"patterns": null,
148148
"role": "Read,Write"
149149
}
150150
'
@@ -156,7 +156,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
156156
-perm "Read,Write"
157157
```
158158

159-
Either setting the `pattern` field to `nil` or just resetting the user permission directly, will eliminate the white list and give back the access permission to the user.
159+
Either setting the `pattern` field to `null` or just resetting the user permission directly, will eliminate the white list and give back the access permission to the user.
160160

161161
## Sub-command `create` Complete Parameters
162162
usage: cql create [common params] [-wait-tx-confirm] [db_meta_params]

docs/cql_intro.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@ CovenantSQL provides a `cql` command line toolset for terminal users to access a
1010
The `cql` command needs to rely on a private key file `private.key` and a config file `config.yaml`:
1111

1212
- `private.key`:a private key file which is generated while creating an account, be sure to keep it safe
13-
- `config.yaml`:mainly used to config the CovenantSQL network for `cql` command to connect (e.g., the [TestNet](quickstart) or the [Docker Environment](deployment))
13+
- `config.yaml`:mainly used to config the CovenantSQL network for `cql` command to connect (e.g., the [TestNet](quickstart) or the [Private Deploy](advanced_deployment))
1414

1515
For security, the private key file is usually encrypted with a master key. A master key is individually chosen by the user while creating an account and is memorized or kept somewhere by the user -- note that the config file will not keep the master key. When the private key is required by the `cql` command, it will ask the user to input the master key to decrypt the private key file.
1616

17+
## Command Format
18+
19+
The `cql` command has more than a dozen subcommands, each one follows the same command format. e.g:
20+
21+
cql sub-command [common parameters] [subcommand parameters] arguments
22+
23+
The content of `arguments` may be empty, but it must be placed at the end of the command when it is not empty.
24+
1725
## Common Parameters for Sub-commands
1826

1927
The following parameters are commonly used by `cql` sub-commands:

docs/cql_wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Output:
5454

5555
## Transferring Tokens to Another Account
5656

57-
Once you get tokens from [TestNet](quickstart) or [Docker Environment](deployment), you can use the `transfer` sub-command to transfer tokens to another account. The command takes 3 main parameters, e.g.:
57+
Once you get tokens from [TestNet](quickstart) or [Private Deploy](advanced_deployment), you can use the `transfer` sub-command to transfer tokens to another account. The command takes 3 main parameters, e.g.:
5858

5959
```bash
6060
cql transfer -to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 -amount 1000000 -token Particle

website/translated_docs/zh-CN/version-0.6.0/cql_account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ cql generate
7272

7373
## 子命令 `generate` 完整参数
7474

75-
通用参数部分参考 [子命令通用参数](#子命令通用参数),以下介绍其他子命令时不再另外说明。
75+
通用参数部分参考 [子命令通用参数](cql_intro#子命令通用参数),以下介绍其他子命令时不再另外说明。
7676

7777
usage: cql generate [common params] [-source template_file] [-miner] [-private existing_private_key] [dest_path]
7878

website/translated_docs/zh-CN/version-0.6.0/cql_db_access.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ cql console 'covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332
1919

2020
co:4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5=>
2121

22-
或者使用以授权的账号来连接:
22+
或者使用以授权的账号来连接 (需要完成上一节的授权和给数据库充值的操作)
2323

2424
```bash
2525
cql console -config "account2/config.yaml" 'covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5'
@@ -55,7 +55,7 @@ cql console -config "account2/config.yaml" 'covenantsql://4bc27a06ae52a7b8b1747f
5555

5656
子命令 `console` 同时也支持在后台启动 `adapter``explorer` 服务,关于这些服务的相关说明请参考 [本地服务](#本地服务) 的相关章节。
5757

58-
usage: cql console [通用参数] [-command sqlcommand] [-file filename] [-out outputfile] [-no-rc true/false] [-single-transaction] [-variable variables] [-explorer explorer_addr] [-adapter adapter_addr] [dsn]
58+
usage: cql console [通用参数] [Console 参数] dsn
5959

6060
为 CovenantSQL 运行交互式的命令行访问。
6161
示例:
@@ -66,7 +66,7 @@ cql console -config "account2/config.yaml" 'covenantsql://4bc27a06ae52a7b8b1747f
6666
示例:
6767
cql console -command "create table test1(test2 int);" covenantsql://4119ef997dedc585bfbcfae00ab6b87b8486fab323a8e107ea1fd4fc4f7eba5c
6868

69-
Console params:
69+
Console 参数:
7070
-adapter string
7171
指定数据库子链的 adapter 服务器的监听地址
7272
-command string

website/translated_docs/zh-CN/version-0.6.0/cql_db_manage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
145145
-to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 \
146146
-perm '
147147
{
148-
"patterns": nil,
148+
"patterns": null,
149149
"role": "Read,Write"
150150
}
151151
'
@@ -157,7 +157,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
157157
-perm "Read,Write"
158158
```
159159

160-
`pattern` 设置为 `nil` 或直接设置用户权限,都可以将用户的白名单限制去掉,设置回可以查询所有内容的读权限。
160+
`pattern` 设置为 `null` 或直接设置用户权限,都可以将用户的白名单限制去掉,设置回可以查询所有内容的读权限。
161161

162162
## 子命令 `create` 完整参数
163163

website/translated_docs/zh-CN/version-0.6.0/cql_intro.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@ CovenantSQL 为终端用户提供 `cql` 命令行工具集,用于对用户账
1010
运行 `cql` 依赖私钥文件 `private.key` 和配置文件 `config.yaml`,其中:
1111

1212
- `private.key`:生成用户账户时所分配的私钥,请务必妥善保管好这个私钥
13-
- `config.yaml`:主要用于配置 `cql` 命令要连接的 CovenantSQL 网络(如 [TestNet](quickstart) 或用户使用 [Docker 一键部署](deployment)的网络)
13+
- `config.yaml`:主要用于配置 `cql` 命令要连接的 CovenantSQL 网络(如 [TestNet](quickstart) 或用户使用 [私有部署](advanced_deployment)的网络)
1414

1515
出于安全方面的考虑,私钥文件通常需要使用主密码进行加密。主密码在创建账号时由用户输入,之后由用户自行记忆或保管,而不会保存到配置文件中。当需要使用到私钥的时候,`cql` 命令会要求用户输入主密码以解开私钥文件。
1616

17+
### 命令格式
18+
19+
`cql` 命令有十多个子命令,各个子命令都遵从相同的命令格式。例如:
20+
21+
cql 子命令 [通用参数] [子命令参数] 选项
22+
23+
其中`选项`的内容可能是空,但非空时必须放在命令最后面
24+
1725
### 子命令通用参数
1826

1927
以下列出子命令中使用到的通用参数:

website/translated_docs/zh-CN/version-0.6.0/cql_wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ cql wallet -token Bitcoin
5555

5656
## 向其他账号转账
5757

58-
[TestNet](quickstart) 获得代币或 [Docker 一键部署](deployment)的网络获得代币后,可以使用 `transfer` 命令来向其他账号转账。转账操作有3个必要的转账信息作为参数,例如:
58+
[TestNet](quickstart) 获得代币或 [私有部署](advanced_deployment) 的网络获得代币后,可以使用 `transfer` 命令来向其他账号转账。转账操作有3个必要的转账信息作为参数,例如:
5959

6060
```bash
6161
cql transfer -to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 -amount 1000000 -token Particle

0 commit comments

Comments
 (0)