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 13:26:43 UTC
[incubator-seatunnel] branch dev updated: [Hotfix][Docs] Fix dead links (#3021)
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 b83c9934c [Hotfix][Docs] Fix dead links (#3021)
b83c9934c is described below
commit b83c9934ca7dd5d4da431aebe4ca573fbad9372c
Author: TyrantLucifer <Ty...@gmail.com>
AuthorDate: Sat Oct 8 21:26:35 2022 +0800
[Hotfix][Docs] Fix dead links (#3021)
* [Hotfix][Docs] Fix dead links
* [Docs][Connector-V2-status] Update the location of this docs.
---
README.md | 2 +-
docs/en/Connector-v2-release-state.md | 57 ++++
.../connector-status/connector-health-status.md | 57 ----
docs/sidebars.js | 365 ++++++++++-----------
4 files changed, 232 insertions(+), 249 deletions(-)
diff --git a/README.md b/README.md
index 564b60226..d75c86185 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ processing plug-in, because the whole system is easy to expand.
- 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)
+### Here's a list of our connectors with their health status.[connector status](/docs/en/Connector-v2-release-state.md)
## Environmental dependency
diff --git a/docs/en/Connector-v2-release-state.md b/docs/en/Connector-v2-release-state.md
new file mode 100644
index 000000000..dca04b53e
--- /dev/null
+++ b/docs/en/Connector-v2-release-state.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](connector-v2/sink/Assert.md) | Sink | Beta | 2.2.0-beta |
+| [ClickHouse](connector-v2/source/Clickhouse.md) | Source | Beta | 2.2.0-beta |
+| [ClickHouse](connector-v2/sink/Clickhouse.md) | Sink | Beta | 2.2.0-beta |
+| [ClickHouseFile](connector-v2/sink/ClickhouseFile.md) | Sink | Beta | 2.2.0-beta |
+| [Console](connector-v2/sink/Console.md) | Sink | Beta | 2.2.0-beta |
+| [DataHub](connector-v2/sink/Datahub.md) | Sink | Alpha | 2.2.0-beta |
+| [DingTalk](connector-v2/sink/dingtalk.md) | Sink | Alpha | 2.2.0-beta |
+| [Elasticsearch](connector-v2/sink/Elasticsearch.md) | Sink | Beta | 2.2.0-beta |
+| [Email](connector-v2/sink/Email.md) | Sink | Alpha | 2.2.0-beta |
+| [Enterprise WeChat](connector-v2/sink/Enterprise-WeChat.md) | Sink | Alpha | 2.2.0-beta |
+| [FeiShu](connector-v2/sink/Feishu.md) | Sink | Alpha | 2.2.0-beta |
+| [Fake](connector-v2/source/FakeSource.md) | Source | Alpha | 2.2.0-beta |
+| [FtpFile](connector-v2/sink/FtpFile.md) | Sink | Alpha | 2.2.0-beta |
+| [Greenplum](connector-v2/sink/Greenplum.md) | Sink | Alpha | 2.2.0-beta |
+| [Greenplum](connector-v2/source/Greenplum.md) | Source | Alpha | 2.2.0-beta |
+| [HdfsFile](connector-v2/sink/HdfsFile.md) | Sink | Beta | 2.2.0-beta |
+| [HdfsFile](connector-v2/source/HdfsFile.md) | Source | Beta | 2.2.0-beta |
+| [Hive](connector-v2/sink/Hive.md) | Sink | Alpha | 2.2.0-beta |
+| [Hive](connector-v2/source/Hive.md) | Source | Beta | 2.2.0-beta |
+| [Http](connector-v2/sink/Http.md) | Sink | Beta | 2.2.0-beta |
+| [Http](connector-v2/source/Http.md) | Source | Beta | 2.2.0-beta |
+| [Hudi](connector-v2/source/Hudi.md) | Source | Alpha | 2.2.0-beta |
+| [Iceberg](connector-v2/source/Iceberg.md) | Source | Alpha | 2.2.0-beta |
+| [IoTDB](connector-v2/source/IoTDB.md) | Source | Beta | 2.2.0-beta |
+| [IoTDB](connector-v2/sink/IoTDB.md) | Sink | Beta | 2.2.0-beta |
+| [Jdbc](connector-v2/source/Jdbc.md) | Source | Beta | 2.2.0-beta |
+| [Jdbc](connector-v2/sink/Jdbc.md) | Sink | Beta | 2.2.0-beta |
+| [Kudu](connector-v2/source/Kudu.md) | Source | Alpha | 2.2.0-beta |
+| [Kudu](connector-v2/sink/Kudu.md) | Sink | Alpha | 2.2.0-beta |
+| [LocalFile](connector-v2/sink/LocalFile.md) | Sink | Beta | 2.2.0-beta |
+| [LocalFile](connector-v2/source/LocalFile.md) | Source | Beta | 2.2.0-beta |
+| [MongoDB](connector-v2/source/MongoDB.md) | Source | Beta | 2.2.0-beta |
+| [MongoDB](connector-v2/sink/MongoDB.md) | Sink | Beta | 2.2.0-beta |
+| [Neo4j](connector-v2/sink/Neo4j.md) | Sink | Alpha | 2.2.0-beta |
+| [OssFile](connector-v2/sink/OssFile.md) | Sink | Alpha | 2.2.0-beta |
+| [OssFile](connector-v2/source/OssFile.md) | Source | Beta | 2.2.0-beta |
+| [Phoenix](connector-v2/sink/Phoenix.md) | Sink | Alpha | 2.2.0-beta |
+| [Phoenix](connector-v2/source/Phoenix.md) | Source | Alpha | 2.2.0-beta |
+| [Pulsar](connector-v2/source/pulsar.md) | Source | Beta | 2.2.0-beta |
+| [Redis](connector-v2/sink/Redis.md) | Sink | Beta | 2.2.0-beta |
+| [Redis](connector-v2/source/Redis.md) | Source | Alpha | 2.2.0-beta |
+| [Sentry](connector-v2/sink/Sentry.md) | Sink | Alpha | 2.2.0-beta |
+| [Socket](connector-v2/sink/Socket.md) | Sink | Alpha | 2.2.0-beta |
+| [Socket](connector-v2/source/Socket.md) | Source | Alpha | 2.2.0-beta |
diff --git a/docs/en/connector-v2/connector-status/connector-health-status.md b/docs/en/connector-v2/connector-status/connector-health-status.md
deleted file mode 100644
index 622045fba..000000000
--- a/docs/en/connector-v2/connector-status/connector-health-status.md
+++ /dev/null
@@ -1,57 +0,0 @@
-## 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 2e2304be2..5204a420a 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -30,215 +30,198 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
- // By default, Docusaurus generates a sidebar from the docs folder structure
- // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+ // By default, Docusaurus generates a sidebar from the docs folder structure
+ // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
- // But you can create a sidebar manually
- /*
- tutorialSidebar: [
- {
- type: 'category',
- label: 'Tutorial',
- items: ['hello'],
- },
- ],
- */
-
- docs: [
- {
- type: 'category',
- label: 'Introduction',
- items: [
- 'intro/about',
- 'intro/why',
- 'intro/history',
- ],
- },
- {
- type: 'category',
- label: 'Quick Start',
- link: {
- type: 'generated-index',
- title: 'Quick Start for SeaTunnel',
- description: 'In this section, you could learn how to get up and running Apache SeaTunnel in both locally or in Docker environment.',
- slug: '/category/start',
- keywords: ['start'],
- image: '/img/favicon.ico',
- },
- items: [
- 'start/local',
- 'start/docker',
- 'start/kubernetes'
- ],
- },
- {
- type: 'category',
- label: 'Concept',
- items: [
- 'concept/config',
- 'concept/connector-v2-features',
- ],
- },
+ // But you can create a sidebar manually
+ /*
+ tutorialSidebar: [
{
- type: 'category',
- label: 'Connector-V2',
- items: [
- {
- type: 'category',
- label: 'Status',
- link: {
+ type: 'category',
+ label: 'Tutorial',
+ items: ['hello'],
+ },
+ ],
+ */
+
+ docs: [
+ {
+ type: 'category',
+ label: 'Introduction',
+ items: [
+ 'intro/about',
+ 'intro/why',
+ 'intro/history',
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Quick Start',
+ link: {
+ type: 'generated-index',
+ title: 'Quick Start for SeaTunnel',
+ description: 'In this section, you could learn how to get up and running Apache SeaTunnel in both locally or in Docker environment.',
+ slug: '/category/start',
+ keywords: ['start'],
+ image: '/img/favicon.ico',
+ },
+ items: [
+ 'start/local',
+ 'start/docker',
+ 'start/kubernetes'
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Concept',
+ items: [
+ 'concept/config',
+ 'concept/connector-v2-features',
+ ],
+ },
+ 'Connector-v2-release-state',
+ {
+ type: 'category',
+ label: 'Connector-V2',
+ items: [
+ {
+ type: 'category',
+ label: 'Sink',
+ link: {
+ type: 'generated-index',
+ title: 'Sink-V2 of SeaTunnel',
+ description: 'List all Sink supported Apache SeaTunnel for now.',
+ // Should remove the `v2` suffix when we migrate all sink to v2 and delete the old one
+ slug: '/category/sink-v2',
+ keywords: ['sink'],
+ image: '/img/favicon.ico',
+ },
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'connector-v2/sink',
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Source',
+ link: {
type: 'generated-index',
- title: 'Connector-V2 Status',
- description: 'Connector-V2 Status',
- slug: '/category/connector-v2-status',
- keywords: ['connector-v2-status'],
+ title: 'Source-V2 of SeaTunnel',
+ description: 'List all source supported Apache SeaTunnel for now.',
+ // Should remove the `v2` suffix when we migrate all sink to v2 and delete the old one
+ slug: '/category/source-v2',
+ keywords: ['source'],
image: '/img/favicon.ico',
},
items: [
{
type: 'autogenerated',
- dirName: 'connector-v2/connector-health-state',
- },
+ dirName: 'connector-v2/source',
+ },
],
- },
- {
- type: 'category',
- label: 'Sink',
- link: {
- type: 'generated-index',
- title: 'Sink-V2 of SeaTunnel',
- description: 'List all Sink supported Apache SeaTunnel for now.',
- // Should remove the `v2` suffix when we migrate all sink to v2 and delete the old one
- slug: '/category/sink-v2',
- keywords: ['sink'],
- image: '/img/favicon.ico',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'connector-v2/sink',
- },
- ],
- },
- {
- type: 'category',
- label: 'Source',
- link: {
- type: 'generated-index',
- title: 'Source-V2 of SeaTunnel',
- description: 'List all source supported Apache SeaTunnel for now.',
- // Should remove the `v2` suffix when we migrate all sink to v2 and delete the old one
- slug: '/category/source-v2',
- keywords: ['source'],
- image: '/img/favicon.ico',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'connector-v2/source',
- },
- ],
- },
- ],
- },
- {
- type: 'category',
- label: 'Connector',
- items: [
+ },
+ ],
+ },
{
- type: 'category',
- label: 'Source',
- link: {
- type: 'generated-index',
- title: 'Source of SeaTunnel',
- description: 'List all source supported Apache SeaTunnel for now.',
- slug: '/category/source',
- keywords: ['source'],
- image: '/img/favicon.ico',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'connector/source',
- },
- ],
+ type: 'category',
+ label: 'Connector',
+ items: [
+ {
+ type: 'category',
+ label: 'Source',
+ link: {
+ type: 'generated-index',
+ title: 'Source of SeaTunnel',
+ description: 'List all source supported Apache SeaTunnel for now.',
+ slug: '/category/source',
+ keywords: ['source'],
+ image: '/img/favicon.ico',
+ },
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'connector/source',
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Sink',
+ link: {
+ type: 'generated-index',
+ title: 'Sink of SeaTunnel',
+ description: 'List all sink supported Apache SeaTunnel for now.',
+ slug: '/category/sink',
+ keywords: ['sink'],
+ image: '/img/favicon.ico',
+ },
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'connector/sink',
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'flink-sql',
+ link: {
+ type: 'generated-index',
+ title: 'Flink-sql of SeaTunnel',
+ description: 'List all flink-sql supported Apache SeaTunnel for now.',
+ slug: '/category/flink-sql',
+ keywords: ['flink-sql'],
+ image: '/img/favicon.ico',
+ },
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'connector/flink-sql',
+ },
+ ],
+ },
+ ],
},
{
- type: 'category',
- label: 'Sink',
- link: {
- type: 'generated-index',
- title: 'Sink of SeaTunnel',
- description: 'List all sink supported Apache SeaTunnel for now.',
- slug: '/category/sink',
- keywords: ['sink'],
- image: '/img/favicon.ico',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'connector/sink',
+ type: 'category',
+ label: 'Transform',
+ link: {
+ type: 'generated-index',
+ title: 'Transform of SeaTunnel',
+ description: 'List all transform supported Apache SeaTunnel for now.',
+ slug: '/category/transform',
+ keywords: ['transform'],
+ image: '/img/favicon.ico',
},
- ],
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'transform',
+ },
+ ],
},
{
- type: 'category',
- label: 'flink-sql',
- link: {
- type: 'generated-index',
- title: 'Flink-sql of SeaTunnel',
- description: 'List all flink-sql supported Apache SeaTunnel for now.',
- slug: '/category/flink-sql',
- keywords: ['flink-sql'],
- image: '/img/favicon.ico',
- },
- items: [
- {
- type: 'autogenerated',
- dirName: 'connector/flink-sql',
- },
- ],
+ type: 'category',
+ label: 'Command',
+ items: [
+ 'command/usage',
+ ],
},
- ],
- },
- {
- type: 'category',
- label: 'Transform',
- link: {
- type: 'generated-index',
- title: 'Transform of SeaTunnel',
- description: 'List all transform supported Apache SeaTunnel for now.',
- slug: '/category/transform',
- keywords: ['transform'],
- image: '/img/favicon.ico',
+ 'deployment',
+ {
+ type: 'category',
+ label: 'Contribution',
+ items: [
+ 'contribution/setup',
+ 'contribution/new-license',
+ 'contribution/coding-guide',
+ ],
},
- items: [
- {
- type: 'autogenerated',
- dirName: 'transform',
- },
- ],
- },
- {
- type: 'category',
- label: 'Command',
- items: [
- 'command/usage',
- ],
- },
- 'deployment',
- {
- type: 'category',
- label: 'Contribution',
- items: [
- 'contribution/setup',
- 'contribution/new-license',
- 'contribution/coding-guide',
- ],
- },
- 'faq',
- ]
+ 'faq',
+ ]
};
module.exports = sidebars