You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by ty...@apache.org on 2022/10/08 10:38:30 UTC

[incubator-seatunnel] branch dev updated: [Docs] Add connector release status (#2864)

This is an automated email from the ASF dual-hosted git repository.

tyrantlucifer 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 ba00f06b0 [Docs] Add connector release status (#2864)
ba00f06b0 is described below

commit ba00f06b0e78e6719e0e1c08955704e9312befa4
Author: Kirs <ki...@apache.org>
AuthorDate: Sat Oct 8 18:38:24 2022 +0800

    [Docs] Add connector release status (#2864)
    
    * [Docs]Add connector release status
    
    * Update connector status and add connector link
    
    * fix siderbar error
---
 README.md                                          |  6 ++-
 .../connector-status/connector-health-status.md    | 57 ++++++++++++++++++++++
 docs/sidebars.js                                   | 18 +++++++
 3 files changed, 79 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f8db709e6..564b60226 100644
--- a/README.md
+++ b/README.md
@@ -60,12 +60,14 @@ accustomed to SQL, you can also directly construct a data processing pipeline by
 Currently, the filter list supported by SeaTunnel is still being expanded. Furthermore, you can develop your own data
 processing plug-in, because the whole system is easy to expand.
 
-## Plugins supported by SeaTunnel
+## Connectors supported by SeaTunnel
 
-- Connectors supported [check out](https://seatunnel.apache.org/docs/category/source)
+- Connectors supported [check out](https://seatunnel.apache.org/docs/category/source-v2)
 
 - Transform supported [check out](https://seatunnel.apache.org/docs/transform/common-options/)
 
+### Here's a list of our connectors with their health status.[connector status](/docs/en/connector-v2/connector-status/connector-health-status.md)
+
 ## Environmental dependency
 
 1. java runtime environment, java >= 8
diff --git a/docs/en/connector-v2/connector-status/connector-health-status.md b/docs/en/connector-v2/connector-status/connector-health-status.md
new file mode 100644
index 000000000..622045fba
--- /dev/null
+++ b/docs/en/connector-v2/connector-status/connector-health-status.md
@@ -0,0 +1,57 @@
+## Connector Release Status
+SeaTunnel uses a grading system for connectors to help you understand what to expect from a connector:
+
+|                      | Alpha                                                                                                                                                                                                            | Beta                                                                                                                                                                                                                                       | General Availabilit [...]
+|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------- [...]
+| Expectations         | An alpha connector signifies a connector under development and helps SeaTunnel gather early feedback and issues reported by early adopters. We strongly discourage using alpha releases for production use cases | A beta connector is considered stable and reliable with no backwards incompatible changes but has not been validated by a broader group of users. We expect to find and fix a few issues and bugs in the release before it’s ready for GA. | A generally availab [...]
+|                      |                                                                                                                                                                                                                  |                                                                                                                                                                                                                                            |                     [...]
+| Production Readiness | No                                                                                                                                                                                                               | Yes                                                                                                                                                                                                                                        | Yes                 [...]
+
+## Connector V2 Health
+
+| Connector Name                                    | Type   | Status | Support Version |
+|---------------------------------------------------|--------|--------|-----------------|
+| [Asset](../sink/Assert.md)                        | Sink   | Beta   | 2.2.0-beta      |
+| [ClickHouse](../source/Clickhouse.md)             | Source | Beta   | 2.2.0-beta      |
+| [ClickHouse](../sink/Clickhouse.md)               | Sink   | Beta   | 2.2.0-beta      |
+| [ClickHouseFile](../sink/ClickhouseFile.md)       | Sink   | Beta   | 2.2.0-beta      |
+| [Console](../sink/Console.md)                     | Sink   | Beta   | 2.2.0-beta      |
+| [DataHub](../sink/Datahub.md)                     | Sink   | Alpha  | 2.2.0-beta      |
+| [DingTalk](../sink/dingtalk.md)                   | Sink   | Alpha  | 2.2.0-beta      |
+| [Elasticsearch](../sink/Elasticsearch.md)         | Sink   | Beta   | 2.2.0-beta      |
+| [Email](../sink/Email.md)                         | Sink   | Alpha  | 2.2.0-beta      |
+| [Enterprise WeChat](../sink/Enterprise-WeChat.md) | Sink   | Alpha  | 2.2.0-beta      |
+| [FeiShu](../sink/Feishu.md)                       | Sink   | Alpha  | 2.2.0-beta      |
+| [Fake](../source/FakeSource.md)                   | Source | Alpha  | 2.2.0-beta      |
+| [FtpFile](../sink/FtpFile.md)                     | Sink   | Alpha  | 2.2.0-beta      |
+| [Greenplum](../sink/Greenplum.md)                 | Sink   | Alpha  | 2.2.0-beta      |
+| [Greenplum](../source/Greenplum.md)               | Source | Alpha  | 2.2.0-beta      |
+| [HdfsFile](../sink/HdfsFile.md)                   | Sink   | Beta   | 2.2.0-beta      |
+| [HdfsFile](../source/HdfsFile.md)                 | Source | Beta   | 2.2.0-beta      |
+| [Hive](../sink/Hive.md)                           | Sink   | Alpha  | 2.2.0-beta      |
+| [Hive](../source/Hive.md)                         | Source | Beta   | 2.2.0-beta      |
+| [Http](../sink/Http.md)                           | Sink   | Beta   | 2.2.0-beta      |
+| [Http](../source/Http.md)                         | Source | Beta   | 2.2.0-beta      |
+| [Hudi](../source/Hudi.md)                         | Source | Alpha  | 2.2.0-beta      |
+| [Iceberg](../source/Iceberg.md)                   | Source | Alpha  | 2.2.0-beta      |
+| [IoTDB](../source/IoTDB.md)                       | Source | Beta   | 2.2.0-beta      |
+| [IoTDB](../sink/IoTDB.md)                         | Sink   | Beta   | 2.2.0-beta      |
+| [Jdbc](../source/Jdbc.md)                         | Source | Beta   | 2.2.0-beta      |
+| [Jdbc](../sink/Jdbc.md)                           | Sink   | Beta   | 2.2.0-beta      |
+| [Kudu](../source/Kudu.md)                         | Source | Alpha  | 2.2.0-beta      |
+| [Kudu](../sink/Kudu.md)                           | Sink   | Alpha  | 2.2.0-beta      |
+| [LocalFile](../sink/LocalFile.md)                 | Sink   | Beta   | 2.2.0-beta      |
+| [LocalFile](../source/LocalFile.md)               | Source | Beta   | 2.2.0-beta      |
+| [MongoDB](../source/MongoDB.md)                   | Source | Beta   | 2.2.0-beta      |
+| [MongoDB](../sink/MongoDB.md)                     | Sink   | Beta   | 2.2.0-beta      |
+| [Neo4j](../sink/Neo4j.md)                         | Sink   | Alpha  | 2.2.0-beta      |
+| [OssFile](../sink/OssFile.md)                     | Sink   | Alpha  | 2.2.0-beta      |
+| [OssFile](../source/OssFile.md)                   | Source | Beta   | 2.2.0-beta      |
+| [Phoenix](../sink/Phoenix.md)                     | Sink   | Alpha  | 2.2.0-beta      |
+| [Phoenix](../source/Phoenix.md)                   | Source | Alpha  | 2.2.0-beta      |
+| [Pulsar](../source/pulsar.md)                     | Source | Beta   | 2.2.0-beta      |
+| [Redis](../sink/redis.md)                         | Sink   | Beta   | 2.2.0-beta      |
+| [Redis](../source/redis.md)                       | Source | Alpha  | 2.2.0-beta      |
+| [Sentry](../sink/Sentry.md)                       | Sink   | Alpha  | 2.2.0-beta      |
+| [Socket](../sink/Socket.md)                       | Sink   | Alpha  | 2.2.0-beta      |
+| [Socket](../source/Socket.md)                     | Source | Alpha  | 2.2.0-beta      |
diff --git a/docs/sidebars.js b/docs/sidebars.js
index e4cc069a1..2e2304be2 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -83,6 +83,24 @@ const sidebars = {
           type: 'category',
           label: 'Connector-V2',
           items: [
+              {
+                  type: 'category',
+                  label: 'Status',
+                  link: {
+                        type: 'generated-index',
+                        title: 'Connector-V2 Status',
+                        description: 'Connector-V2 Status',
+                        slug: '/category/connector-v2-status',
+                        keywords: ['connector-v2-status'],
+                        image: '/img/favicon.ico',
+                    },
+                    items: [
+                        {
+                            type: 'autogenerated',
+                            dirName: 'connector-v2/connector-health-state',
+                        },  
+                    ],
+              },
               {
                   type: 'category',
                   label: 'Sink',