blob: 5dfc65b1fcd45495c87da51979872aaf7e8d12fb [file] [log] [blame]
commit e8bb00f875d457295ae30c9f2b7d6a34a41634fb
Author: 孙念君 Sun Nianjun <sunnianjun@huobi.com>
Date: Tue Apr 6 18:03:59 2021 +0800
documentation improve (#9947)
* Document: correct some issues in documentation
* Document: add extra content for quick start
* Document: update the example path
Co-authored-by: 孙念君 <sunnianjun@bizseer.com>
diff --git a/docs/document/content/faq/_index.cn.md b/docs/document/content/faq/_index.cn.md
index ca91357b95..81c88bcea4 100644
--- a/docs/document/content/faq/_index.cn.md
+++ b/docs/document/content/faq/_index.cn.md
@@ -12,7 +12,7 @@ chapter = true
ShardingSphere-Proxy以及ShardingSphere-JDBC 1.5.0版本之后提供了`sql.show`的配置,可以将解析上下文和改写后的SQL以及最终路由至的数据源的细节信息全部打印至info日志。
`sql.show`配置默认关闭,如果需要请通过配置开启。
-注意:5.x版本以后,`sql.show`参数调整为`sql-show`
+> 注意:5.x版本以后,`sql.show`参数调整为`sql-show`
## 2. 阅读源码时为什么会出现编译错误?
diff --git a/docs/document/content/features/sharding/concept/sharding.cn.md b/docs/document/content/features/sharding/concept/sharding.cn.md
index 80931b9ffe..15190e787c 100644
--- a/docs/document/content/features/sharding/concept/sharding.cn.md
+++ b/docs/document/content/features/sharding/concept/sharding.cn.md
@@ -35,7 +35,7 @@ SQL 中如果无分片字段,将执行全路由,性能较差。
- 标准分片策略
-对应 StandardShardingStrategy。提供对 SQ L语句中的 `=`, `>`, `<`, `>=`, `<=`, `IN` `BETWEEN AND` 的分片操作支持。
+对应 StandardShardingStrategy。提供对 SQL 语句中的 `=`, `>`, `<`, `>=`, `<=`, `IN` `BETWEEN AND` 的分片操作支持。
StandardShardingStrategy 只支持单分片键,提供 PreciseShardingAlgorithm RangeShardingAlgorithm 两个分片算法。
PreciseShardingAlgorithm 是必选的,用于处理 `=` `IN` 的分片。
RangeShardingAlgorithm 是可选的,用于处理 `BETWEEN AND`, `>`, `<`, `>=`, `<=`分片,如果不配置 RangeShardingAlgorithmSQL 中的 `BETWEEN AND` 将按照全库路由处理。
diff --git a/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.cn.md b/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.cn.md
index de475b5b85..47405ad1ba 100644
--- a/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.cn.md
+++ b/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.cn.md
@@ -14,7 +14,7 @@ weight = 1
</dependency>
```
-注意:请将 `${latest.release.version}` 更改为实际的版本号。
+> 注意:请将 `${latest.release.version}` 更改为实际的版本号。
## 2. 规则配置
diff --git a/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.en.md b/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.en.md
index 17fdf67f79..dbabea131b 100644
--- a/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.en.md
+++ b/docs/document/content/quick-start/shardingsphere-jdbc-quick-start.en.md
@@ -14,7 +14,7 @@ weight = 1
</dependency>
```
-Notice: Please change `${latest.release.version}` to the actual version.
+> Notice: Please change `${latest.release.version}` to the actual version.
## 2. Rules Configuration
diff --git a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
index 0ec598669a..37a3ea18e8 100644
--- a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
+++ b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
@@ -10,6 +10,8 @@ weight = 2
编辑`%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`。详情请参见[配置手册](/cn/user-manual/shardingsphere-proxy/configuration/)。
+> %SHARDINGSPHERE_PROXY_HOME% Proxy 解压后的路径,例:/Users/ss/shardingsphere-proxy-bin/
+
## 2. 引入依赖
如果后端连接 PostgreSQL 数据库,不需要引入额外依赖。
diff --git a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
index 6d36b80161..dfd0c184e1 100644
--- a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
+++ b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
@@ -10,6 +10,8 @@ Edit `%SHARDINGSPHERE_PROXY_HOME%/conf/config-xxx.yaml`. Please refer to [Config
Edit `%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`. Please refer to [Configuration Manual](/en/user-manual/shardingsphere-proxy/configuration/) for more details.
+> %SHARDINGSPHERE_PROXY_HOME% is the shardingsphere proxy extract path. for example: /Users/ss/shardingsphere-proxy-bin/
+
## 2. Import Dependencies
If the backend database is PostgreSQL, there's no need for additional dependencies.
diff --git a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
index 4273b30c46..25ed24ffb4 100644
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
+++ b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
@@ -8,6 +8,8 @@ weight = 3
编辑`%SHARDINGSPHERE_SCALING_HOME%/conf/server.yaml`。详情请参见[使用手册](/cn/user-manual/shardingsphere-scaling/usage/)。
+> %SHARDINGSPHERE_PROXY_HOME% 为 Scaling 解压后的路径,例:/Users/ss/shardingsphere-scaling-bin/
+
## 2. 引入依赖
如果后端连接 PostgreSQL 数据库,不需要引入额外依赖。
diff --git a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
index c7df807f75..d167b7e62f 100644
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
+++ b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
@@ -8,6 +8,8 @@ weight = 3
Edit `%SHARDINGSPHERE_SCALING_HOME%/conf/server.yaml`. Please refer to [Configuration Manual](/en/user-manual/shardingsphere-scaling/usage/) for more details.
+> %SHARDINGSPHERE_PROXY_HOME% is the shardingsphere scaling extract path. for example: /Users/ss/shardingsphere-scaling-bin/
+
## 2. Import Dependencies
If the backend database is PostgreSQL, there's no need for additional dependencies.