This is an automated email from the ASF dual-hosted git repository.
zhangliang 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 555c858f8a3 Update document for explanation of the symbol to (+) and
(?) (#37158)
555c858f8a3 is described below
commit 555c858f8a307169f37c85b932a02fc80bbdec25
Author: Liang Zhang <[email protected]>
AuthorDate: Sat Nov 22 14:31:51 2025 +0800
Update document for explanation of the symbol to (+) and (?) (#37158)
---
docs/document/content/user-manual/_index.cn.md | 6 ++++++
docs/document/content/user-manual/_index.en.md | 6 ++++++
2 files changed, 12 insertions(+)
diff --git a/docs/document/content/user-manual/_index.cn.md
b/docs/document/content/user-manual/_index.cn.md
index 7a15b1ff432..b49d6c1ef14 100644
--- a/docs/document/content/user-manual/_index.cn.md
+++ b/docs/document/content/user-manual/_index.cn.md
@@ -6,3 +6,9 @@ chapter = true
+++
本章节面向 Apache ShardingSphere 的用户,详细阐述项目的使用说明。
+
+## 符号说明
+
+- `(+)`:必填项;集合需至少包含一个元素。
+- `(?)`:可选项;缺省时使用默认值。
+- `(*)`:可选集合;缺省为空或无需配置。
diff --git a/docs/document/content/user-manual/_index.en.md
b/docs/document/content/user-manual/_index.en.md
index aae0095cb27..6808a37ccb5 100644
--- a/docs/document/content/user-manual/_index.en.md
+++ b/docs/document/content/user-manual/_index.en.md
@@ -6,3 +6,9 @@ chapter = true
+++
This chapter describes how to use projects of Apache ShardingSphere.
+
+## Notation
+
+- `(+)`: required; for collections, provide at least one item.
+- `(?)`: optional; default applies if omitted.
+- `(*)`: optional collection; defaults to empty or no entry.