This is an automated email from the ASF dual-hosted git repository.
shenghang pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new e08285db71 [Doc] Adjust the file structure under concepts (#10420)
e08285db71 is described below
commit e08285db71e4a634e9ea657cd5dc2ede773f85b7
Author: misi <[email protected]>
AuthorDate: Wed Feb 4 19:59:30 2026 +0800
[Doc] Adjust the file structure under concepts (#10420)
Co-authored-by: misi <[email protected]>
---
.../connector-isolated-dependency.md | 0
.../concepts => engines}/event-listener.md | 0
docs/en/introduction/concepts/config.md | 6 ++---
.../introduction/concepts/connector-v2-features.md | 2 +-
.../{concepts => configuration}/JobEnvConfig.md | 0
.../config-encryption-decryption.md | 0
.../{concepts => configuration}/metalake.md | 0
.../schema-evolution.md | 0
.../sink-options-placeholders.md | 0
.../{concepts => configuration}/speed-limit.md | 0
.../{concepts => configuration}/sql-config.md | 0
docs/sidebars.js | 27 +++++++++++++---------
.../connector-isolated-dependency.md | 0
.../concepts => engines}/event-listener.md | 0
docs/zh/introduction/concepts/config.md | 6 ++---
.../introduction/concepts/connector-v2-features.md | 2 +-
.../{concepts => configuration}/JobEnvConfig.md | 0
.../config-encryption-decryption.md | 0
.../{concepts => configuration}/metalake.md | 0
.../schema-evolution.md | 0
.../sink-options-placeholders.md | 0
.../{concepts => configuration}/speed-limit.md | 0
.../{concepts => configuration}/sql-config.md | 0
23 files changed, 24 insertions(+), 19 deletions(-)
diff --git a/docs/en/introduction/concepts/connector-isolated-dependency.md
b/docs/en/connectors/connector-isolated-dependency.md
similarity index 100%
rename from docs/en/introduction/concepts/connector-isolated-dependency.md
rename to docs/en/connectors/connector-isolated-dependency.md
diff --git a/docs/en/introduction/concepts/event-listener.md
b/docs/en/engines/event-listener.md
similarity index 100%
rename from docs/en/introduction/concepts/event-listener.md
rename to docs/en/engines/event-listener.md
diff --git a/docs/en/introduction/concepts/config.md
b/docs/en/introduction/concepts/config.md
index 4ac33bf6be..4fc2942785 100644
--- a/docs/en/introduction/concepts/config.md
+++ b/docs/en/introduction/concepts/config.md
@@ -7,7 +7,7 @@ configure the config file.
The main format of the config file is `hocon`, for more details you can refer
to [HOCON-GUIDE](https://github.com/lightbend/config/blob/main/HOCON.md),
BTW, we also support the `json` format, but you should keep in mind that the
name of the config file should end with `.json`.
-We also support the `SQL` format, please refer to [SQL
configuration](sql-config.md) for more details.
+We also support the `SQL` format, please refer to [SQL
configuration](../configuration/sql-config.md) for more details.
## Example
@@ -76,7 +76,7 @@ Used to add some engine optional parameters, no matter which
engine (Zeta, Spark
optional parameters should be filled in here.
Note that we have separated the parameters by engine, and for the common
parameters, we can configure them as before.
-For flink and spark engine, the specific configuration rules of their
parameters can be referred to [JobEnvConfig](./JobEnvConfig.md).
+For flink and spark engine, the specific configuration rules of their
parameters can be referred to [JobEnvConfig](../configuration/JobEnvConfig.md).
<!-- TODO add supported env parameters -->
@@ -333,7 +333,7 @@ sink {
- If the substitution variable contains double or single quotes (e.g.,
`"resName"` or `"nameVal"`), you need to include them with the value.
- The value cannot contain spaces (`' '`). For example, `-i jobName='this is a
job name'` will be replaced with `job.name = "this"`. You can use environment
variables to pass values with spaces.
- For dynamic parameters, you can use the following format: `-i date=$(date
+"%Y%m%d")`.
-- Cannot use specified system reserved characters; they will not be replaced
by `-i`, such as: `${database_name}`, `${schema_name}`, `${table_name}`,
`${schema_full_name}`, `${table_full_name}`, `${primary_key}`, `${unique_key}`,
`${field_names}`, `${partition_keys}`. For details, please refer to [Sink
Parameter Placeholders](sink-options-placeholders.md).
+- Cannot use specified system reserved characters; they will not be replaced
by `-i`, such as: `${database_name}`, `${schema_name}`, `${table_name}`,
`${schema_full_name}`, `${table_full_name}`, `${primary_key}`, `${unique_key}`,
`${field_names}`, `${partition_keys}`. For details, please refer to [Sink
Parameter Placeholders](../configuration/sink-options-placeholders.md).
## What's More
diff --git a/docs/en/introduction/concepts/connector-v2-features.md
b/docs/en/introduction/concepts/connector-v2-features.md
index cfbf6a021c..9b20ccc4dc 100644
--- a/docs/en/introduction/concepts/connector-v2-features.md
+++ b/docs/en/introduction/concepts/connector-v2-features.md
@@ -77,7 +77,7 @@ If a sink connector supports writing row
kinds(INSERT/UPDATE_BEFORE/UPDATE_AFTER
### support multiple table write
-Supports write multiple tables in one SeaTunnel job, users can dynamically
specify the table's identifier by [configuring
placeholders](./sink-options-placeholders.md).
+Supports write multiple tables in one SeaTunnel job, users can dynamically
specify the table's identifier by [configuring
placeholders](../configuration/sink-options-placeholders.md).
### multimodal
diff --git a/docs/en/introduction/concepts/JobEnvConfig.md
b/docs/en/introduction/configuration/JobEnvConfig.md
similarity index 100%
rename from docs/en/introduction/concepts/JobEnvConfig.md
rename to docs/en/introduction/configuration/JobEnvConfig.md
diff --git a/docs/en/introduction/concepts/config-encryption-decryption.md
b/docs/en/introduction/configuration/config-encryption-decryption.md
similarity index 100%
rename from docs/en/introduction/concepts/config-encryption-decryption.md
rename to docs/en/introduction/configuration/config-encryption-decryption.md
diff --git a/docs/en/introduction/concepts/metalake.md
b/docs/en/introduction/configuration/metalake.md
similarity index 100%
rename from docs/en/introduction/concepts/metalake.md
rename to docs/en/introduction/configuration/metalake.md
diff --git a/docs/en/introduction/concepts/schema-evolution.md
b/docs/en/introduction/configuration/schema-evolution.md
similarity index 100%
rename from docs/en/introduction/concepts/schema-evolution.md
rename to docs/en/introduction/configuration/schema-evolution.md
diff --git a/docs/en/introduction/concepts/sink-options-placeholders.md
b/docs/en/introduction/configuration/sink-options-placeholders.md
similarity index 100%
rename from docs/en/introduction/concepts/sink-options-placeholders.md
rename to docs/en/introduction/configuration/sink-options-placeholders.md
diff --git a/docs/en/introduction/concepts/speed-limit.md
b/docs/en/introduction/configuration/speed-limit.md
similarity index 100%
rename from docs/en/introduction/concepts/speed-limit.md
rename to docs/en/introduction/configuration/speed-limit.md
diff --git a/docs/en/introduction/concepts/sql-config.md
b/docs/en/introduction/configuration/sql-config.md
similarity index 100%
rename from docs/en/introduction/concepts/sql-config.md
rename to docs/en/introduction/configuration/sql-config.md
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 17a1495cf7..27397e54eb 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -31,18 +31,21 @@ const sidebars = {
"label": "Concepts",
"items": [
"introduction/concepts/config",
- "introduction/concepts/config-encryption-decryption",
"introduction/concepts/connector-v2-features",
- "introduction/concepts/connector-isolated-dependency",
- "introduction/concepts/schema-feature",
- "introduction/concepts/JobEnvConfig",
- "introduction/concepts/sink-options-placeholders",
- "introduction/concepts/sql-config",
- "introduction/concepts/speed-limit",
- "introduction/concepts/event-listener",
- "introduction/concepts/schema-evolution",
- "introduction/concepts/metalake",
- "introduction/concepts/incompatible-changes"
+ "introduction/concepts/schema-feature"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Configuration",
+ "items": [
+ "introduction/configuration/JobEnvConfig",
+ "introduction/configuration/sql-config",
+
"introduction/configuration/config-encryption-decryption",
+ "introduction/configuration/metalake",
+ "introduction/configuration/sink-options-placeholders",
+ "introduction/configuration/schema-evolution",
+ "introduction/configuration/speed-limit"
]
}
]
@@ -82,6 +85,7 @@ const sidebars = {
"type": "category",
"label": "Connectors",
"items": [
+ "connectors/connector-isolated-dependency",
{
"type": "category",
"label": "Source",
@@ -213,6 +217,7 @@ const sidebars = {
"label": "Engines",
"items": [
"engines/overview",
+ "engines/event-listener",
{
"type": "category",
"label": "SeaTunnel Engine (Zeta)",
diff --git a/docs/zh/introduction/concepts/connector-isolated-dependency.md
b/docs/zh/connectors/connector-isolated-dependency.md
similarity index 100%
rename from docs/zh/introduction/concepts/connector-isolated-dependency.md
rename to docs/zh/connectors/connector-isolated-dependency.md
diff --git a/docs/zh/introduction/concepts/event-listener.md
b/docs/zh/engines/event-listener.md
similarity index 100%
rename from docs/zh/introduction/concepts/event-listener.md
rename to docs/zh/engines/event-listener.md
diff --git a/docs/zh/introduction/concepts/config.md
b/docs/zh/introduction/concepts/config.md
index 8898e798a5..4507fbdbc3 100644
--- a/docs/zh/introduction/concepts/config.md
+++ b/docs/zh/introduction/concepts/config.md
@@ -5,7 +5,7 @@
配置文件的主要格式是 `hocon`,
有关该格式类型的更多信息你可以参考[HOCON-GUIDE](https://github.com/lightbend/config/blob/main/HOCON.md),
顺便提一下，我们也支持 `json`格式，但你应该知道配置文件的名称应该是以 `.json`结尾。
-我们同时提供了以 `SQL` 格式，详细可以参考[SQL配置文件](sql-config.md)。
+我们同时提供了以 `SQL` 格式，详细可以参考[SQL配置文件](../configuration/sql-config.md)。
## 例子
@@ -70,7 +70,7 @@ sink {
用于添加引擎可选的参数，不管是什么引擎（Zeta、Spark 或者 Flink），对应的可选参数应该在这里填写。
-注意，我们按照引擎分离了参数，对于公共参数我们可以像以前一样配置。对于Flink和Spark引擎，其参数的具体配置规则可以参考[JobEnvConfig](JobEnvConfig.md)。
+注意，我们按照引擎分离了参数，对于公共参数我们可以像以前一样配置。对于Flink和Spark引擎，其参数的具体配置规则可以参考[JobEnvConfig](../configuration/JobEnvConfig.md)。
<!-- TODO add supported env parameters -->
@@ -321,7 +321,7 @@ sink {
- 如果替换变量包含`"`或`'`(如`"resName"`和`"nameVal"`)，需要添加`"`。
- 值不能包含空格`' '`。例如, `-i jobName='this is a job name'`将被替换为`job.name = "this"`。
你可以使用环境变量传递带有空格的值。
- 如果要使用动态参数,可以使用以下格式: `-i date=$(date +"%Y%m%d")`。
--
不能使用指定系统保留字符，它将不会被`-i`替换，如:`${database_name}`、`${schema_name}`、`${table_name}`、`${schema_full_name}`、`${table_full_name}`、`${primary_key}`、`${unique_key}`、`${field_names}`、`${partition_keys}`。具体可参考[Sink参数占位符](sink-options-placeholders.md)
+-
不能使用指定系统保留字符，它将不会被`-i`替换，如:`${database_name}`、`${schema_name}`、`${table_name}`、`${schema_full_name}`、`${table_full_name}`、`${primary_key}`、`${unique_key}`、`${field_names}`、`${partition_keys}`。具体可参考[Sink参数占位符](../configuration/sink-options-placeholders.md)
## 此外
如果你想了解更多关于格式配置的详细信息，请查看
[HOCON](https://github.com/lightbend/config/blob/main/HOCON.md)。
diff --git a/docs/zh/introduction/concepts/connector-v2-features.md
b/docs/zh/introduction/concepts/connector-v2-features.md
index 0bd67c3aff..d0894d3bfb 100644
--- a/docs/zh/introduction/concepts/connector-v2-features.md
+++ b/docs/zh/introduction/concepts/connector-v2-features.md
@@ -76,7 +76,7 @@ Sink connector有一些公共的核心特性，每个sink connector在不同程
### 支持多表读取
-支持在一个 SeaTunnel 作业中写入多个表，用户可以通过[配置占位符](sink-options-placeholders.md)动态指定表的标识符。
+支持在一个 SeaTunnel
作业中写入多个表，用户可以通过[配置占位符](../configuration/sink-options-placeholders.md)动态指定表的标识符。
### 多模态（multimodal）
diff --git a/docs/zh/introduction/concepts/JobEnvConfig.md
b/docs/zh/introduction/configuration/JobEnvConfig.md
similarity index 100%
rename from docs/zh/introduction/concepts/JobEnvConfig.md
rename to docs/zh/introduction/configuration/JobEnvConfig.md
diff --git a/docs/zh/introduction/concepts/config-encryption-decryption.md
b/docs/zh/introduction/configuration/config-encryption-decryption.md
similarity index 100%
rename from docs/zh/introduction/concepts/config-encryption-decryption.md
rename to docs/zh/introduction/configuration/config-encryption-decryption.md
diff --git a/docs/zh/introduction/concepts/metalake.md
b/docs/zh/introduction/configuration/metalake.md
similarity index 100%
rename from docs/zh/introduction/concepts/metalake.md
rename to docs/zh/introduction/configuration/metalake.md
diff --git a/docs/zh/introduction/concepts/schema-evolution.md
b/docs/zh/introduction/configuration/schema-evolution.md
similarity index 100%
rename from docs/zh/introduction/concepts/schema-evolution.md
rename to docs/zh/introduction/configuration/schema-evolution.md
diff --git a/docs/zh/introduction/concepts/sink-options-placeholders.md
b/docs/zh/introduction/configuration/sink-options-placeholders.md
similarity index 100%
rename from docs/zh/introduction/concepts/sink-options-placeholders.md
rename to docs/zh/introduction/configuration/sink-options-placeholders.md
diff --git a/docs/zh/introduction/concepts/speed-limit.md
b/docs/zh/introduction/configuration/speed-limit.md
similarity index 100%
rename from docs/zh/introduction/concepts/speed-limit.md
rename to docs/zh/introduction/configuration/speed-limit.md
diff --git a/docs/zh/introduction/concepts/sql-config.md
b/docs/zh/introduction/configuration/sql-config.md
similarity index 100%
rename from docs/zh/introduction/concepts/sql-config.md
rename to docs/zh/introduction/configuration/sql-config.md
