This is an automated email from the ASF dual-hosted git repository.
fanjia pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new f19db744b [Doc][Connector/Transform] Fix empty description (#2375)
f19db744b is described below
commit f19db744b301d825c433678eb8da2d69b66be349
Author: TyrantLucifer <[email protected]>
AuthorDate: Sun Aug 7 15:08:53 2022 +0800
[Doc][Connector/Transform] Fix empty description (#2375)
* [Doc][Connector-V2] Add description information for source connectors
* [Doc][Connector-V2] Add description information for sink connectors
* [Doc][Transform] Add description information for transform plugins
* [Doc][Connector-Flink-SQL] Add description information for flink sql
connectors
* [Doc][Connector-V1] Add description information for sink connectors
* [Doc][Connector-V1] Add description information for source connectors
---
docs/en/connector-v2/sink/Assert.md | 2 ++
docs/en/connector-v2/sink/Clickhouse.md | 2 ++
docs/en/connector-v2/sink/ClickhouseFile.md | 2 ++
docs/en/connector-v2/sink/HdfsFile.md | 2 ++
docs/en/connector-v2/sink/Hive.md | 2 ++
docs/en/connector-v2/sink/Http.md | 2 ++
docs/en/connector-v2/sink/Jdbc.md | 3 +++
docs/en/connector-v2/sink/Kudu.md | 2 ++
docs/en/connector-v2/sink/LocalFile.md | 2 ++
docs/en/connector-v2/sink/common-options.md | 2 +-
docs/en/connector-v2/sink/dingtalk.md | 2 ++
docs/en/connector-v2/source/Clickhouse.md | 2 ++
docs/en/connector-v2/source/Email.md | 2 ++
docs/en/connector-v2/source/Http.md | 3 +++
docs/en/connector-v2/source/Hudi.md | 2 ++
docs/en/connector-v2/source/Jdbc.md | 4 ++++
docs/en/connector-v2/source/Kudu.md | 2 ++
docs/en/connector-v2/source/Socket.md | 3 +++
docs/en/connector-v2/source/common-options.md | 2 +-
docs/en/connector-v2/source/pulsar.md | 2 ++
docs/en/connector/flink-sql/ElasticSearch.md | 2 ++
docs/en/connector/flink-sql/Jdbc.md | 2 ++
docs/en/connector/flink-sql/Kafka.md | 2 ++
docs/en/connector/flink-sql/usage.md | 2 ++
docs/en/connector/sink/Assert.md | 2 +-
docs/en/connector/sink/Clickhouse.md | 2 ++
docs/en/connector/sink/ClickhouseFile.md | 2 ++
docs/en/connector/sink/Console.mdx | 2 ++
docs/en/connector/sink/Doris.mdx | 2 ++
docs/en/connector/sink/Druid.md | 2 +-
docs/en/connector/sink/Elasticsearch.mdx | 2 ++
docs/en/connector/sink/Email.md | 2 ++
docs/en/connector/sink/File.mdx | 2 ++
docs/en/connector/sink/Hbase.md | 2 ++
docs/en/connector/sink/Hive.md | 2 ++
docs/en/connector/sink/Hudi.md | 2 ++
docs/en/connector/sink/Iceberg.md | 2 ++
docs/en/connector/sink/InfluxDb.md | 2 ++
docs/en/connector/sink/Jdbc.mdx | 2 ++
docs/en/connector/sink/Kafka.md | 2 ++
docs/en/connector/sink/Kudu.md | 2 ++
docs/en/connector/sink/MongoDB.md | 2 ++
docs/en/connector/sink/Phoenix.md | 2 ++
docs/en/connector/sink/Redis.md | 2 ++
docs/en/connector/sink/Tidb.md | 2 ++
docs/en/connector/sink/common-options.md | 2 +-
docs/en/connector/source/Druid.md | 2 ++
docs/en/connector/source/Elasticsearch.md | 2 ++
docs/en/connector/source/Fake.mdx | 2 ++
docs/en/connector/source/FeishuSheet.md | 2 ++
docs/en/connector/source/File.mdx | 2 ++
docs/en/connector/source/Hbase.md | 2 ++
docs/en/connector/source/Hive.md | 2 ++
docs/en/connector/source/Http.md | 2 ++
docs/en/connector/source/Hudi.md | 2 ++
docs/en/connector/source/Iceberg.md | 2 ++
docs/en/connector/source/InfluxDb.md | 2 ++
docs/en/connector/source/Jdbc.mdx | 2 ++
docs/en/connector/source/Kafka.mdx | 2 ++
docs/en/connector/source/Kudu.md | 2 ++
docs/en/connector/source/MongoDB.md | 2 ++
docs/en/connector/source/Phoenix.md | 2 ++
docs/en/connector/source/Redis.md | 2 ++
docs/en/connector/source/Socket.mdx | 2 ++
docs/en/connector/source/Tidb.md | 2 ++
docs/en/connector/source/Webhook.md | 2 ++
docs/en/connector/source/common-options.mdx | 2 +-
docs/en/connector/source/neo4j.md | 2 ++
docs/en/transform/common-options.mdx | 2 ++
docs/en/transform/json.md | 2 ++
docs/en/transform/nullRate.md | 2 ++
docs/en/transform/nulltf.md | 2 ++
docs/en/transform/replace.md | 2 ++
docs/en/transform/split.mdx | 2 ++
docs/en/transform/sql.md | 2 ++
docs/en/transform/udf.md | 2 ++
docs/en/transform/uuid.md | 2 ++
77 files changed, 153 insertions(+), 6 deletions(-)
diff --git a/docs/en/connector-v2/sink/Assert.md
b/docs/en/connector-v2/sink/Assert.md
index 382465d72..ca9332d0c 100644
--- a/docs/en/connector-v2/sink/Assert.md
+++ b/docs/en/connector-v2/sink/Assert.md
@@ -1,5 +1,7 @@
# Assert
+> Assert sink connector
+
## Description
A flink sink plugin which can assert illegal data by user defined rules
diff --git a/docs/en/connector-v2/sink/Clickhouse.md
b/docs/en/connector-v2/sink/Clickhouse.md
index 83895c859..ff1e89989 100644
--- a/docs/en/connector-v2/sink/Clickhouse.md
+++ b/docs/en/connector-v2/sink/Clickhouse.md
@@ -1,5 +1,7 @@
# Clickhouse
+> Clickhouse sink connector
+
## Description
Used to write data to Clickhouse. Supports Batch and Streaming mode.
diff --git a/docs/en/connector-v2/sink/ClickhouseFile.md
b/docs/en/connector-v2/sink/ClickhouseFile.md
index 12bdf69a7..f1c6e3024 100644
--- a/docs/en/connector-v2/sink/ClickhouseFile.md
+++ b/docs/en/connector-v2/sink/ClickhouseFile.md
@@ -1,5 +1,7 @@
# ClickhouseFile
+> Clickhouse file sink connector
+
## Description
Generate the clickhouse data file with the clickhouse-local program, and then
send it to the clickhouse
diff --git a/docs/en/connector-v2/sink/HdfsFile.md
b/docs/en/connector-v2/sink/HdfsFile.md
index b3d692c33..2513d59c1 100644
--- a/docs/en/connector-v2/sink/HdfsFile.md
+++ b/docs/en/connector-v2/sink/HdfsFile.md
@@ -1,5 +1,7 @@
# HdfsFile
+> HDFS file sink connector
+
## Description
Output data to hdfs file. Support bounded and unbounded job.
diff --git a/docs/en/connector-v2/sink/Hive.md
b/docs/en/connector-v2/sink/Hive.md
index 1794633f1..b5ae8edc4 100644
--- a/docs/en/connector-v2/sink/Hive.md
+++ b/docs/en/connector-v2/sink/Hive.md
@@ -1,5 +1,7 @@
# Hive
+> Hive sink connector
+
## Description
Write data to Hive.
diff --git a/docs/en/connector-v2/sink/Http.md
b/docs/en/connector-v2/sink/Http.md
index a83d4a679..c871b9c16 100644
--- a/docs/en/connector-v2/sink/Http.md
+++ b/docs/en/connector-v2/sink/Http.md
@@ -1,5 +1,7 @@
# Http
+> Http sink connector
+
## Description
Used to launch web hooks using data. Both support streaming and batch mode.
diff --git a/docs/en/connector-v2/sink/Jdbc.md
b/docs/en/connector-v2/sink/Jdbc.md
index 746b9fe4b..e5063c61b 100644
--- a/docs/en/connector-v2/sink/Jdbc.md
+++ b/docs/en/connector-v2/sink/Jdbc.md
@@ -1,4 +1,7 @@
# JDBC
+
+> JDBC sink connector
+
## Description
Write data through jdbc. Support Batch mode and Streaming mode, support
concurrent writing, support exactly-once semantics (using XA transaction
guarantee).
## Options
diff --git a/docs/en/connector-v2/sink/Kudu.md
b/docs/en/connector-v2/sink/Kudu.md
index 4ccb993dc..9a67831da 100644
--- a/docs/en/connector-v2/sink/Kudu.md
+++ b/docs/en/connector-v2/sink/Kudu.md
@@ -1,5 +1,7 @@
# Kudu
+> Kudu sink connector
+
## Description
Write data to Kudu.
diff --git a/docs/en/connector-v2/sink/LocalFile.md
b/docs/en/connector-v2/sink/LocalFile.md
index c8ef79305..f7e820cc8 100644
--- a/docs/en/connector-v2/sink/LocalFile.md
+++ b/docs/en/connector-v2/sink/LocalFile.md
@@ -1,5 +1,7 @@
# LocalFile
+> Local file sink connector
+
## Description
Output data to local file. Support bounded and unbounded job.
diff --git a/docs/en/connector-v2/sink/common-options.md
b/docs/en/connector-v2/sink/common-options.md
index 620ef3bb2..ac4a2e428 100644
--- a/docs/en/connector-v2/sink/common-options.md
+++ b/docs/en/connector-v2/sink/common-options.md
@@ -1,6 +1,6 @@
# Common Options
-## Sink Plugin common parameters
+> Common parameters of sink connectors
| name | type | required | default value |
| ----------------- | ------ | -------- | ------------- |
diff --git a/docs/en/connector-v2/sink/dingtalk.md
b/docs/en/connector-v2/sink/dingtalk.md
index eb3ebef9d..6fe0e2a43 100644
--- a/docs/en/connector-v2/sink/dingtalk.md
+++ b/docs/en/connector-v2/sink/dingtalk.md
@@ -1,5 +1,7 @@
# DingTalk
+> DinkTalk sink connector
+
## Description
A sink plugin which use DingTalk robot send message
diff --git a/docs/en/connector-v2/source/Clickhouse.md
b/docs/en/connector-v2/source/Clickhouse.md
index aaf7d0ad9..7e761c0ee 100644
--- a/docs/en/connector-v2/source/Clickhouse.md
+++ b/docs/en/connector-v2/source/Clickhouse.md
@@ -1,5 +1,7 @@
# Clickhouse
+> Clickhouse source connector
+
## Description
Used to read data from Clickhouse. Currently, only supports Batch mode.
diff --git a/docs/en/connector-v2/source/Email.md
b/docs/en/connector-v2/source/Email.md
index 0ae3706c5..fdd137117 100644
--- a/docs/en/connector-v2/source/Email.md
+++ b/docs/en/connector-v2/source/Email.md
@@ -1,5 +1,7 @@
# Email
+> Email source connector
+
## Description
Send the data as a file to email.
diff --git a/docs/en/connector-v2/source/Http.md
b/docs/en/connector-v2/source/Http.md
index e19000942..816e23aa8 100644
--- a/docs/en/connector-v2/source/Http.md
+++ b/docs/en/connector-v2/source/Http.md
@@ -1,4 +1,7 @@
# Http
+
+> Http source connector
+
## Description
Used to read data from Http. Both support streaming and batch mode.
diff --git a/docs/en/connector-v2/source/Hudi.md
b/docs/en/connector-v2/source/Hudi.md
index 4851d61ef..2fb9f0604 100644
--- a/docs/en/connector-v2/source/Hudi.md
+++ b/docs/en/connector-v2/source/Hudi.md
@@ -1,5 +1,7 @@
# Hudi
+> Hudi source connector
+
## Description
Used to read data from Hudi. Currently, only supports hudi cow table and
Snapshot Query with Batch Mode.
diff --git a/docs/en/connector-v2/source/Jdbc.md
b/docs/en/connector-v2/source/Jdbc.md
index 4a56c65f8..18c075d2c 100644
--- a/docs/en/connector-v2/source/Jdbc.md
+++ b/docs/en/connector-v2/source/Jdbc.md
@@ -1,5 +1,9 @@
# JDBC
+
+> JDBC source connector
+
## Description
+
Read external data source data through JDBC. Currently supports mysql and
Postgres databases, and supports Batch mode.
## Options
diff --git a/docs/en/connector-v2/source/Kudu.md
b/docs/en/connector-v2/source/Kudu.md
index 7b85bc7cd..3cb6cff76 100644
--- a/docs/en/connector-v2/source/Kudu.md
+++ b/docs/en/connector-v2/source/Kudu.md
@@ -1,5 +1,7 @@
# Kudu
+> Kudu source connector
+
## Description
Used to read data from Kudu. Currently, only supports Query with Batch Mode.
diff --git a/docs/en/connector-v2/source/Socket.md
b/docs/en/connector-v2/source/Socket.md
index bb8fe89bb..b9b0a2540 100644
--- a/docs/en/connector-v2/source/Socket.md
+++ b/docs/en/connector-v2/source/Socket.md
@@ -1,4 +1,7 @@
# Socket
+
+> Socket source connector
+
## Description
Used to read data from Socket. Both support streaming and batch mode.
diff --git a/docs/en/connector-v2/source/common-options.md
b/docs/en/connector-v2/source/common-options.md
index cf2dccd9e..529732743 100644
--- a/docs/en/connector-v2/source/common-options.md
+++ b/docs/en/connector-v2/source/common-options.md
@@ -1,6 +1,6 @@
# Common Options
-## Source common parameters
+> Common parameters of source connectors
| name | type | required | default value |
| ----------------- | ------ | -------- | ------------- |
diff --git a/docs/en/connector-v2/source/pulsar.md
b/docs/en/connector-v2/source/pulsar.md
index 68f9da4df..b028dd361 100644
--- a/docs/en/connector-v2/source/pulsar.md
+++ b/docs/en/connector-v2/source/pulsar.md
@@ -1,5 +1,7 @@
# Apache Pulsar
+> Apache Pulsar source connector
+
## Description
Source connector for Apache Pulsar. It can support both off-line and real-time
jobs.
diff --git a/docs/en/connector/flink-sql/ElasticSearch.md
b/docs/en/connector/flink-sql/ElasticSearch.md
index 14b643c2f..b41d2bd43 100644
--- a/docs/en/connector/flink-sql/ElasticSearch.md
+++ b/docs/en/connector/flink-sql/ElasticSearch.md
@@ -1,5 +1,7 @@
# Flink SQL ElasticSearch Connector
+> ElasticSearch connector based flink sql
+
## Description
With elasticsearch connector, you can use the Flink SQL to write data into
ElasticSearch.
diff --git a/docs/en/connector/flink-sql/Jdbc.md
b/docs/en/connector/flink-sql/Jdbc.md
index 3e8413c23..113a9e4ac 100644
--- a/docs/en/connector/flink-sql/Jdbc.md
+++ b/docs/en/connector/flink-sql/Jdbc.md
@@ -1,5 +1,7 @@
# Flink SQL JDBC Connector
+> JDBC connector based flink sql
+
## Description
We can use the Flink SQL JDBC Connector to connect to a JDBC database. Refer
to the [Flink SQL JDBC
Connector](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/connectors/table/jdbc/index.html)
for more information.
diff --git a/docs/en/connector/flink-sql/Kafka.md
b/docs/en/connector/flink-sql/Kafka.md
index a24a0a60e..acdd1b055 100644
--- a/docs/en/connector/flink-sql/Kafka.md
+++ b/docs/en/connector/flink-sql/Kafka.md
@@ -1,5 +1,7 @@
# Flink SQL Kafka Connector
+> Kafka connector based by flink sql
+
## Description
With kafka connector, we can read data from kafka and write data to kafka
using Flink SQL. Refer to the [Kafka
connector](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/connectors/table/kafka/)
for more details.
diff --git a/docs/en/connector/flink-sql/usage.md
b/docs/en/connector/flink-sql/usage.md
index 3ffb93d9f..1495b43fe 100644
--- a/docs/en/connector/flink-sql/usage.md
+++ b/docs/en/connector/flink-sql/usage.md
@@ -1,5 +1,7 @@
# How to use flink sql module
+> Tutorial of flink sql module
+
## Usage
### 1. Command Entrypoint
diff --git a/docs/en/connector/sink/Assert.md b/docs/en/connector/sink/Assert.md
index 4e2dcc76b..74316f925 100644
--- a/docs/en/connector/sink/Assert.md
+++ b/docs/en/connector/sink/Assert.md
@@ -1,6 +1,6 @@
# Assert
-> # Sink plugin: Assert [Flink]
+> Assert sink connector
## Description
diff --git a/docs/en/connector/sink/Clickhouse.md
b/docs/en/connector/sink/Clickhouse.md
index 4d2b0bc10..ab926060e 100644
--- a/docs/en/connector/sink/Clickhouse.md
+++ b/docs/en/connector/sink/Clickhouse.md
@@ -1,5 +1,7 @@
# Clickhouse
+> Clickhouse sink connector
+
## Description
Use [Clickhouse-jdbc](https://github.com/ClickHouse/clickhouse-jdbc) to
correspond the data source according to the field name and write it into
ClickHouse. The corresponding data table needs to be created in advance before
use
diff --git a/docs/en/connector/sink/ClickhouseFile.md
b/docs/en/connector/sink/ClickhouseFile.md
index a4d406145..6080846ee 100644
--- a/docs/en/connector/sink/ClickhouseFile.md
+++ b/docs/en/connector/sink/ClickhouseFile.md
@@ -1,5 +1,7 @@
# ClickhouseFile
+> Clickhouse file sink connector
+
## Description
Generate the clickhouse data file with the clickhouse-local program, and then
send it to the clickhouse
diff --git a/docs/en/connector/sink/Console.mdx
b/docs/en/connector/sink/Console.mdx
index 877df7fa2..d20b15341 100644
--- a/docs/en/connector/sink/Console.mdx
+++ b/docs/en/connector/sink/Console.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Console
+> Console sink connector
+
## Description
Output data to standard terminal or Flink taskManager, which is often used for
debugging and easy to observe the data.
diff --git a/docs/en/connector/sink/Doris.mdx b/docs/en/connector/sink/Doris.mdx
index 9e1ca8ded..ebccc9b8e 100644
--- a/docs/en/connector/sink/Doris.mdx
+++ b/docs/en/connector/sink/Doris.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Doris
+> Doris sink connector
+
### Description:
Write Data to a Doris Table.
diff --git a/docs/en/connector/sink/Druid.md b/docs/en/connector/sink/Druid.md
index 534c092cb..363695f38 100644
--- a/docs/en/connector/sink/Druid.md
+++ b/docs/en/connector/sink/Druid.md
@@ -1,6 +1,6 @@
# Druid
-> # Sink plugin: Druid [Flink]
+> Druid sink connector
## Description
diff --git a/docs/en/connector/sink/Elasticsearch.mdx
b/docs/en/connector/sink/Elasticsearch.mdx
index 7e42df935..73a7669a4 100644
--- a/docs/en/connector/sink/Elasticsearch.mdx
+++ b/docs/en/connector/sink/Elasticsearch.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Elasticsearch
+> Elasticsearch sink connector
+
## Description
Output data to `Elasticsearch`.
diff --git a/docs/en/connector/sink/Email.md b/docs/en/connector/sink/Email.md
index 8f50db9c1..406aea308 100644
--- a/docs/en/connector/sink/Email.md
+++ b/docs/en/connector/sink/Email.md
@@ -1,5 +1,7 @@
# Email
+> Email sink connector
+
## Description
Supports data output through `email attachments`. The attachments are in the
`xlsx` format that supports `excel` to open, which can be used to notify the
task statistics results through email attachments.
diff --git a/docs/en/connector/sink/File.mdx b/docs/en/connector/sink/File.mdx
index f82ad1f02..9ce219440 100644
--- a/docs/en/connector/sink/File.mdx
+++ b/docs/en/connector/sink/File.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# File
+> File sink connector
+
## Description
Output data to local or hdfs file.
diff --git a/docs/en/connector/sink/Hbase.md b/docs/en/connector/sink/Hbase.md
index 0c6e8336a..5108be750 100644
--- a/docs/en/connector/sink/Hbase.md
+++ b/docs/en/connector/sink/Hbase.md
@@ -1,5 +1,7 @@
# Hbase
+> Hbase sink connector
+
## Description
Use
[hbase-connectors](https://github.com/apache/hbase-connectors/tree/master/spark)
to output data to `Hbase` , `Hbase (>=2.1.0)` and `Spark (>=2.0.0)` version
compatibility depends on `hbase-connectors` . The `hbase-connectors` in the
official Apache Hbase documentation is also one of the [Apache Hbase
Repos](https://hbase.apache.org/book.html#repos).
diff --git a/docs/en/connector/sink/Hive.md b/docs/en/connector/sink/Hive.md
index 7c57a1afa..50df7cb86 100644
--- a/docs/en/connector/sink/Hive.md
+++ b/docs/en/connector/sink/Hive.md
@@ -1,5 +1,7 @@
# Hive
+> Hive sink connector
+
### Description
Write Rows to [Apache Hive](https://hive.apache.org).
diff --git a/docs/en/connector/sink/Hudi.md b/docs/en/connector/sink/Hudi.md
index 5599bb7ea..b79089cb9 100644
--- a/docs/en/connector/sink/Hudi.md
+++ b/docs/en/connector/sink/Hudi.md
@@ -1,5 +1,7 @@
# Hudi
+> Hudi sink connector
+
## Description
Write Rows to a Hudi.
diff --git a/docs/en/connector/sink/Iceberg.md
b/docs/en/connector/sink/Iceberg.md
index ce281fc7e..3831171c8 100644
--- a/docs/en/connector/sink/Iceberg.md
+++ b/docs/en/connector/sink/Iceberg.md
@@ -1,5 +1,7 @@
# Iceberg
+> Iceberg sink connector
+
## Description
Write data to Iceberg.
diff --git a/docs/en/connector/sink/InfluxDb.md
b/docs/en/connector/sink/InfluxDb.md
index c896e8d6e..fc0f1cdba 100644
--- a/docs/en/connector/sink/InfluxDb.md
+++ b/docs/en/connector/sink/InfluxDb.md
@@ -1,5 +1,7 @@
# InfluxDB
+> InfluxDB sink connector
+
## Description
Write data to InfluxDB.
diff --git a/docs/en/connector/sink/Jdbc.mdx b/docs/en/connector/sink/Jdbc.mdx
index 77d2d2b4c..3e948065b 100644
--- a/docs/en/connector/sink/Jdbc.mdx
+++ b/docs/en/connector/sink/Jdbc.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Jdbc
+> JDBC sink connector
+
## Description
Write data through jdbc
diff --git a/docs/en/connector/sink/Kafka.md b/docs/en/connector/sink/Kafka.md
index bee26c935..5d8535a5e 100644
--- a/docs/en/connector/sink/Kafka.md
+++ b/docs/en/connector/sink/Kafka.md
@@ -1,5 +1,7 @@
# Kafka
+> Kafka sink connector
+
## Description
Write Rows to a Kafka topic.
diff --git a/docs/en/connector/sink/Kudu.md b/docs/en/connector/sink/Kudu.md
index c82963ecc..857ac34d9 100644
--- a/docs/en/connector/sink/Kudu.md
+++ b/docs/en/connector/sink/Kudu.md
@@ -1,5 +1,7 @@
# Kudu
+> Kudu sink connector
+
## Description
Write data to Kudu.
diff --git a/docs/en/connector/sink/MongoDB.md
b/docs/en/connector/sink/MongoDB.md
index 8004acfef..fe35d729a 100644
--- a/docs/en/connector/sink/MongoDB.md
+++ b/docs/en/connector/sink/MongoDB.md
@@ -1,5 +1,7 @@
# MongoDB
+> MongoDB sink connector
+
## Description
Write data to `MongoDB`
diff --git a/docs/en/connector/sink/Phoenix.md
b/docs/en/connector/sink/Phoenix.md
index 0f4c69d67..12547c010 100644
--- a/docs/en/connector/sink/Phoenix.md
+++ b/docs/en/connector/sink/Phoenix.md
@@ -1,5 +1,7 @@
# Phoenix
+> Phoenix sink connector
+
## Description
Export data to `Phoenix` , compatible with `Kerberos` authentication
diff --git a/docs/en/connector/sink/Redis.md b/docs/en/connector/sink/Redis.md
index 8a2510ca9..85e89061a 100644
--- a/docs/en/connector/sink/Redis.md
+++ b/docs/en/connector/sink/Redis.md
@@ -1,5 +1,7 @@
# Redis
+> Redis sink connector
+
## Description
Write Rows to a Redis.
diff --git a/docs/en/connector/sink/Tidb.md b/docs/en/connector/sink/Tidb.md
index 5a6588387..78d193c17 100644
--- a/docs/en/connector/sink/Tidb.md
+++ b/docs/en/connector/sink/Tidb.md
@@ -1,5 +1,7 @@
# TiDb
+> TiDB sink connector
+
### Description
Write data to TiDB.
diff --git a/docs/en/connector/sink/common-options.md
b/docs/en/connector/sink/common-options.md
index 620ef3bb2..ac4a2e428 100644
--- a/docs/en/connector/sink/common-options.md
+++ b/docs/en/connector/sink/common-options.md
@@ -1,6 +1,6 @@
# Common Options
-## Sink Plugin common parameters
+> Common parameters of sink connectors
| name | type | required | default value |
| ----------------- | ------ | -------- | ------------- |
diff --git a/docs/en/connector/source/Druid.md
b/docs/en/connector/source/Druid.md
index fc5e64856..ed7aaa016 100644
--- a/docs/en/connector/source/Druid.md
+++ b/docs/en/connector/source/Druid.md
@@ -1,5 +1,7 @@
# Druid
+> Druid source connector
+
## Description
Read data from Apache Druid.
diff --git a/docs/en/connector/source/Elasticsearch.md
b/docs/en/connector/source/Elasticsearch.md
index 4a68ab54a..4d205ea00 100644
--- a/docs/en/connector/source/Elasticsearch.md
+++ b/docs/en/connector/source/Elasticsearch.md
@@ -1,5 +1,7 @@
# Elasticsearch
+> Elasticsearch source connector
+
## Description
Read data from Elasticsearch
diff --git a/docs/en/connector/source/Fake.mdx
b/docs/en/connector/source/Fake.mdx
index 12a6c2bfb..95980afca 100644
--- a/docs/en/connector/source/Fake.mdx
+++ b/docs/en/connector/source/Fake.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Fake
+> Fake source connector
+
## Description
`Fake` is mainly used to conveniently generate user-specified data, which is
used as input for functional verification, testing, and performance testing of
seatunnel.
diff --git a/docs/en/connector/source/FeishuSheet.md
b/docs/en/connector/source/FeishuSheet.md
index 744875d18..3784ac6fb 100644
--- a/docs/en/connector/source/FeishuSheet.md
+++ b/docs/en/connector/source/FeishuSheet.md
@@ -1,5 +1,7 @@
# Feishu Sheet
+> Feishu sheet source connector
+
## Description
Get data from Feishu sheet
diff --git a/docs/en/connector/source/File.mdx
b/docs/en/connector/source/File.mdx
index 7f856da2c..068685ec6 100644
--- a/docs/en/connector/source/File.mdx
+++ b/docs/en/connector/source/File.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# File
+> File source connector
+
## Description
Read data from local or hdfs file.
diff --git a/docs/en/connector/source/Hbase.md
b/docs/en/connector/source/Hbase.md
index a96c7852a..45f582acf 100644
--- a/docs/en/connector/source/Hbase.md
+++ b/docs/en/connector/source/Hbase.md
@@ -1,5 +1,7 @@
# HBase
+> Hbase source connector
+
## Description
Get data from HBase
diff --git a/docs/en/connector/source/Hive.md b/docs/en/connector/source/Hive.md
index 9fd71abe4..1254ee69b 100644
--- a/docs/en/connector/source/Hive.md
+++ b/docs/en/connector/source/Hive.md
@@ -1,5 +1,7 @@
# Hive
+> Hive source connector
+
## Description
Get data from hive
diff --git a/docs/en/connector/source/Http.md b/docs/en/connector/source/Http.md
index ad34e9e74..7a5bda992 100644
--- a/docs/en/connector/source/Http.md
+++ b/docs/en/connector/source/Http.md
@@ -1,5 +1,7 @@
# Http
+> Http source connector
+
## Description
Get data from http or https interface
diff --git a/docs/en/connector/source/Hudi.md b/docs/en/connector/source/Hudi.md
index 314877260..05e8d8624 100644
--- a/docs/en/connector/source/Hudi.md
+++ b/docs/en/connector/source/Hudi.md
@@ -1,5 +1,7 @@
# Hudi
+> Hudi source connector
+
## Description
Read data from Hudi.
diff --git a/docs/en/connector/source/Iceberg.md
b/docs/en/connector/source/Iceberg.md
index f7b09844e..db50993ff 100644
--- a/docs/en/connector/source/Iceberg.md
+++ b/docs/en/connector/source/Iceberg.md
@@ -1,5 +1,7 @@
# Iceberg
+> Iceberg source connector
+
## Description
Read data from Iceberg.
diff --git a/docs/en/connector/source/InfluxDb.md
b/docs/en/connector/source/InfluxDb.md
index e57d97e0e..19fce0c31 100644
--- a/docs/en/connector/source/InfluxDb.md
+++ b/docs/en/connector/source/InfluxDb.md
@@ -1,5 +1,7 @@
# InfluxDb
+> InfluxDb source connector
+
## Description
Read data from InfluxDB.
diff --git a/docs/en/connector/source/Jdbc.mdx
b/docs/en/connector/source/Jdbc.mdx
index ca92c1e34..efb350440 100644
--- a/docs/en/connector/source/Jdbc.mdx
+++ b/docs/en/connector/source/Jdbc.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Jdbc
+> JDBC source connector
+
## Description
Read external data source data through JDBC
diff --git a/docs/en/connector/source/Kafka.mdx
b/docs/en/connector/source/Kafka.mdx
index adf08fc30..4777e0893 100644
--- a/docs/en/connector/source/Kafka.mdx
+++ b/docs/en/connector/source/Kafka.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Kafka
+> Kafka source connector
+
## Description
To consume data from `Kafka` , supported `Kafka version >= 0.10.0` .
diff --git a/docs/en/connector/source/Kudu.md b/docs/en/connector/source/Kudu.md
index 6cef52353..431cd6fd5 100644
--- a/docs/en/connector/source/Kudu.md
+++ b/docs/en/connector/source/Kudu.md
@@ -1,5 +1,7 @@
# Kudu
+> Kudu source connector
+
## Description
Read data from Kudu.
diff --git a/docs/en/connector/source/MongoDB.md
b/docs/en/connector/source/MongoDB.md
index 5e7aba355..83de599a2 100644
--- a/docs/en/connector/source/MongoDB.md
+++ b/docs/en/connector/source/MongoDB.md
@@ -1,5 +1,7 @@
# MongoDb
+> MongoDb source connector
+
## Description
Read data from MongoDB.
diff --git a/docs/en/connector/source/Phoenix.md
b/docs/en/connector/source/Phoenix.md
index 0232b040d..b44878155 100644
--- a/docs/en/connector/source/Phoenix.md
+++ b/docs/en/connector/source/Phoenix.md
@@ -1,5 +1,7 @@
# Phoenix
+> Phoenix source connector
+
## Description
Read external data source data through `Phoenix` , compatible with `Kerberos`
authentication
diff --git a/docs/en/connector/source/Redis.md
b/docs/en/connector/source/Redis.md
index adb767eaf..35dfff5b1 100644
--- a/docs/en/connector/source/Redis.md
+++ b/docs/en/connector/source/Redis.md
@@ -1,5 +1,7 @@
# Redis
+> Redis source connector
+
## Description
Read data from Redis.
diff --git a/docs/en/connector/source/Socket.mdx
b/docs/en/connector/source/Socket.mdx
index 797b4d0f0..3588f5f33 100644
--- a/docs/en/connector/source/Socket.mdx
+++ b/docs/en/connector/source/Socket.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Socket
+> Socket source connector
+
## Description
`SocketStream` is mainly used to receive `Socket` data and is used to quickly
verify `Spark streaming` computing.
diff --git a/docs/en/connector/source/Tidb.md b/docs/en/connector/source/Tidb.md
index fd08f9c4a..155fe0c50 100644
--- a/docs/en/connector/source/Tidb.md
+++ b/docs/en/connector/source/Tidb.md
@@ -1,5 +1,7 @@
# Tidb
+> TiDB source connector
+
### Description
Read data from Tidb.
diff --git a/docs/en/connector/source/Webhook.md
b/docs/en/connector/source/Webhook.md
index d8998ecc1..42c35f26c 100644
--- a/docs/en/connector/source/Webhook.md
+++ b/docs/en/connector/source/Webhook.md
@@ -1,5 +1,7 @@
# WebhookStream
+> Webhook source connector
+
## Description
Provide http interface to push data，only supports post requests.
diff --git a/docs/en/connector/source/common-options.mdx
b/docs/en/connector/source/common-options.mdx
index 22ade54ff..833fd8911 100644
--- a/docs/en/connector/source/common-options.mdx
+++ b/docs/en/connector/source/common-options.mdx
@@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem';
# Common Options
-## Source common parameters
+> Common parameters of source connectors
<Tabs
groupId="engine-type"
diff --git a/docs/en/connector/source/neo4j.md
b/docs/en/connector/source/neo4j.md
index 534b6dee5..e50a71931 100644
--- a/docs/en/connector/source/neo4j.md
+++ b/docs/en/connector/source/neo4j.md
@@ -1,5 +1,7 @@
# Neo4j
+> Neo4j source connector
+
## Description
Read data from Neo4j.
diff --git a/docs/en/transform/common-options.mdx
b/docs/en/transform/common-options.mdx
index 766f90700..9f20ea13a 100644
--- a/docs/en/transform/common-options.mdx
+++ b/docs/en/transform/common-options.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Common Options
+> Common parameters of transform plugins
+
:::tip
This transform both supported by engine Spark and Flink.
diff --git a/docs/en/transform/json.md b/docs/en/transform/json.md
index 3068fe7a7..5ec5ba5c1 100644
--- a/docs/en/transform/json.md
+++ b/docs/en/transform/json.md
@@ -1,5 +1,7 @@
# Json
+> Json transform plugin
+
## Description
Json analysis of the specified fields of the original data set
diff --git a/docs/en/transform/nullRate.md b/docs/en/transform/nullRate.md
index 3f4790f6a..a5c7bf1eb 100644
--- a/docs/en/transform/nullRate.md
+++ b/docs/en/transform/nullRate.md
@@ -1,5 +1,7 @@
# NullRate
+> NULL rate transform plugin
+
## Description
When there is a large amount of data, the final result will always be greatly
affected by the problem of data null value. Therefore, early null value
detection is particularly important. For this reason, this function came into
being
diff --git a/docs/en/transform/nulltf.md b/docs/en/transform/nulltf.md
index dad4ee945..55f124d10 100644
--- a/docs/en/transform/nulltf.md
+++ b/docs/en/transform/nulltf.md
@@ -1,5 +1,7 @@
# Nulltf
+> NULL default value transform plugin
+
## Description
set default value for null field
diff --git a/docs/en/transform/replace.md b/docs/en/transform/replace.md
index ecfce6dd5..11499a0e1 100644
--- a/docs/en/transform/replace.md
+++ b/docs/en/transform/replace.md
@@ -1,5 +1,7 @@
# Replace
+> Replace transform plugin
+
## Description
Examines string value in a given field and replaces substring of the string
value that matches the given string literal or regexes with the given
replacement.
diff --git a/docs/en/transform/split.mdx b/docs/en/transform/split.mdx
index ecfe38717..abc288ec1 100644
--- a/docs/en/transform/split.mdx
+++ b/docs/en/transform/split.mdx
@@ -3,6 +3,8 @@ import TabItem from '@theme/TabItem';
# Split
+> Split transform plugin
+
## Description
A string cutting function is defined, which is used to split the specified
field in the Sql plugin.
diff --git a/docs/en/transform/sql.md b/docs/en/transform/sql.md
index 9f8003d48..72af7355c 100644
--- a/docs/en/transform/sql.md
+++ b/docs/en/transform/sql.md
@@ -1,5 +1,7 @@
# Sql
+> Sql transform plugin
+
## Description
Use SQL to process data and support engine's UDF function.
diff --git a/docs/en/transform/udf.md b/docs/en/transform/udf.md
index 2f00d0683..21a37e0e1 100644
--- a/docs/en/transform/udf.md
+++ b/docs/en/transform/udf.md
@@ -1,5 +1,7 @@
# udf
+> UDF transform plugin
+
## Description
Supports using UDF in data integration by the transform.
diff --git a/docs/en/transform/uuid.md b/docs/en/transform/uuid.md
index 4633a843b..6be962dee 100644
--- a/docs/en/transform/uuid.md
+++ b/docs/en/transform/uuid.md
@@ -1,5 +1,7 @@
# UUID
+> UUID transform plugin
+
## Description
Generate a universally unique identifier on a specified field.
