This is an automated email from the ASF dual-hosted git repository.
panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 561b48e Rename yaml to yaml-config (#13619)
561b48e is described below
commit 561b48e0f8f6ab27063190da7b43cdd845c4d6f7
Author: Liang Zhang <[email protected]>
AuthorDate: Mon Nov 15 19:11:51 2021 +0800
Rename yaml to yaml-config (#13619)
* Update index of shardingsphere-proxy
* Rename yaml to yaml-config
---
.../content/user-manual/shardingsphere-jdbc/_index.cn.md | 2 +-
.../content/user-manual/shardingsphere-jdbc/_index.en.md | 2 +-
.../shardingsphere-jdbc/{yaml => yaml-config}/_index.cn.md | 2 +-
.../shardingsphere-jdbc/{yaml => yaml-config}/_index.en.md | 2 +-
.../{yaml => yaml-config}/data-source.cn.md | 0
.../{yaml => yaml-config}/data-source.en.md | 0
.../shardingsphere-jdbc/{yaml => yaml-config}/mode.cn.md | 0
.../shardingsphere-jdbc/{yaml => yaml-config}/mode.en.md | 0
.../{yaml => yaml-config}/rules/_index.cn.md | 0
.../{yaml => yaml-config}/rules/_index.en.md | 0
.../{yaml => yaml-config}/rules/encrypt.cn.md | 0
.../{yaml => yaml-config}/rules/encrypt.en.md | 0
.../{yaml => yaml-config}/rules/ha.cn.md | 0
.../{yaml => yaml-config}/rules/ha.en.md | 0
.../{yaml => yaml-config}/rules/mix.cn.md | 0
.../{yaml => yaml-config}/rules/mix.en.md | 0
.../{yaml => yaml-config}/rules/readwrite-splitting.cn.md | 0
.../{yaml => yaml-config}/rules/readwrite-splitting.en.md | 0
.../{yaml => yaml-config}/rules/shadow.cn.md | 0
.../{yaml => yaml-config}/rules/shadow.en.md | 0
.../{yaml => yaml-config}/rules/sharding.cn.md | 0
.../{yaml => yaml-config}/rules/sharding.en.md | 0
.../content/user-manual/shardingsphere-proxy/_index.cn.md | 13 +++++++++++--
.../content/user-manual/shardingsphere-proxy/_index.en.md | 14 ++++++++++++--
24 files changed, 27 insertions(+), 8 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
index a0b520b..a7b1f86 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
@@ -18,4 +18,4 @@ ShardingSphere-JDBC 提供了 4 种配置方式，用于不同的使用场景。
如果前一个规则是面向数据源聚合的，下一个规则在配置数据源时，则需要使用前一个规则配置的聚合后的逻辑数据源名称；
同理，如果前一个规则是面向表聚合的，下一个规则在配置表时，则需要使用前一个规则配置的聚合后的逻辑表名称。
-更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
+更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples/shardingsphere-jdbc-example)。
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
index 0746ea7..05366f8 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
@@ -19,4 +19,4 @@ It should be noted that the superposition between rules are
data source and tabl
If the previous rule is data source oriented aggregation, the next rule needs
to use the aggregated logical data source name configured by the previous rule
when configuring the data source;
Similarly, if the previous rule is table oriented aggregation, the next rule
needs to use the aggregated logical table name configured by the previous rule
when configuring the table.
-Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
+Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples/shardingsphere-jdbc-example)
for more details.
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md
similarity index 98%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md
index c1fc40f..95021b5 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md
@@ -1,5 +1,5 @@
+++
-title = "YAML"
+title = "YAML 配置"
weight = 2
chapter = true
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md
similarity index 98%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md
index 4575162..9c6f85d 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md
@@ -1,5 +1,5 @@
+++
-title = "YAML"
+title = "YAML Configuration"
weight = 2
chapter = true
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/data-source.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/data-source.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/data-source.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/data-source.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/mode.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/mode.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/mode.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/mode.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/mode.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/mode.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/mode.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/mode.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/_index.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/_index.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/_index.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/_index.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/_index.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/_index.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/encrypt.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/encrypt.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/encrypt.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/encrypt.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/ha.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/ha.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/ha.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/ha.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/mix.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/mix.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/mix.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/mix.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/readwrite-splitting.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/readwrite-splitting.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/readwrite-splitting.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/readwrite-splitting.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/shadow.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/shadow.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/shadow.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/shadow.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/sharding.cn.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
similarity index 100%
rename from
docs/document/content/user-manual/shardingsphere-jdbc/yaml/rules/sharding.en.md
rename to
docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
index c9bce81..db23d46 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
@@ -5,5 +5,14 @@ weight = 2
chapter = true
+++
-本章节面向 ShardingSphere-Proxy 的用户，详细阐述项目的使用说明。
-更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
+配置是 ShardingSphere-Proxy 中唯一与开发者交互的模块，通过它可以快速清晰的理解 ShardingSphere-Proxy 所提供的功能。
+
+本章节是 ShardingSphere-Proxy 的配置参考手册，需要时可当做字典查阅。
+
+ShardingSphere-Proxy 提供基于 YAML 的配置方式，并使用 DistSQL 进行交互。
+通过配置，应用开发者可以灵活的使用数据分片、读写分离、数据加密、影子库等功能，并且能够叠加使用。
+
+规则配置部分与 ShardingSphere-JDBC 的 YAML 配置完全一致。
+DistSQL 与 YAML 配置能够相互取代。
+
+更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples/shardingsphere-proxy-example)。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
index f87899a..149c1ed 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
@@ -5,5 +5,15 @@ weight = 2
chapter = true
+++
-This chapter describes how to use projects of ShardingSphere-Proxy.
-Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
+Configuration is the only module in ShardingSphere-Proxy that interacts with
application developers,
+through which developer can quickly and clearly understand the functions
provided by ShardingSphere-Proxy.
+
+This chapter is a configuration manual for ShardingSphere-Proxy, which can
also be referred to as a dictionary if necessary.
+
+ShardingSphere-Proxy provided YAML configuration, and used DistSQL to
communicate.
+By configuration, application developers can flexibly use data sharding,
readwrite-splitting, data encryption, shadow database or the combination of
them.
+
+Rule configuration keeps consist with YAML configuration of
ShardingSphere-JDBC.
+DistSQL and YAML can be replaced each other.
+
+Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples/shardingsphere-proxy-example)
for more details.
