This is an automated email from the ASF dual-hosted git repository. benjobs pushed a commit to branch adjustment in repository https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
commit b0e3a590c019fab83641c7e89ec60ed4d982e335 Author: benjobs <[email protected]> AuthorDate: Sat Jun 8 18:57:45 2024 +0800 [Improve] minor improvement --- docs/connector/_category_.json | 4 ---- .../3-development.md => development/1.development.md} | 0 docs/development/_category_.json | 4 ++-- docs/flink-k8s/_category_.json | 4 ---- docs/{development/model.md => framework/1.model.md} | 2 +- docs/{development/conf.md => framework/2.conf.md} | 2 +- .../2-quickstart.md => framework/3.quickstart.md} | 4 ++-- docs/framework/_category_.json | 4 ++++ .../1-kafka.md => framework/connector/1.kafka.md} | 0 .../2-jdbc.md => framework/connector/2.jdbc.md} | 0 .../connector/3.clickhouse.md} | 0 .../4-doris.md => framework/connector/4.doris.md} | 0 docs/{connector/5-es.md => framework/connector/5.es.md} | 0 .../6-hbase.md => framework/connector/6.hbase.md} | 0 .../7-http.md => framework/connector/7.http.md} | 0 .../8-redis.md => framework/connector/8.redis.md} | 0 docs/framework/connector/_category_.json | 4 ++++ docs/{intro.md => get-started/1.intro.md} | 0 .../1-deployment.md => get-started/2.deployment.md} | 4 ++-- .../3.dockerDeployment.md} | 6 +++--- .../4.platformBasicUsage.md} | 7 ++++++- docs/get-started/_category_.json | 4 ++++ docs/{development/alert-conf.md => platform/1.alert.md} | 4 ++-- .../10.hadoop-resource-integration.md} | 4 ++-- .../11.k8s-pvc-integration.md} | 4 ++-- docs/{user-guide/5-LDAP.md => platform/2.LDAP.md} | 8 ++++---- .../20.version-upgrade.md} | 2 +- docs/{user-guide/6-Team.md => platform/3.team.md} | 4 ++-- .../7-Variable.md => platform/4.variable.md} | 4 ++-- .../9-ExternalLink.md => platform/5.external-link.md} | 6 +++--- docs/{user-guide/10-SSO.md => platform/6.SSO.md} | 6 +++--- .../7.yarnQueue.md} | 4 ++-- .../8.platform-build.md} | 6 ++++++ .../1-deployment.md => platform/9.flink-on-k8s.md} | 6 +++--- docs/platform/_category_.json | 4 ++++ docs/user-guide/_category_.json | 4 ---- docusaurus.config.js | 2 +- .../current/connector/_category_.json | 4 ---- .../3-development.md => development/1.development.md} | 0 .../current/development/_category_.json | 4 ++-- .../current/flink-k8s/_category_.json | 4 ---- .../{development/model.md => framework/1.model.md} | 4 ++-- .../{development/conf.md => framework/2.conf.md} | 0 .../2-quickstart.md => framework/3.quickstart.md} | 4 ++-- .../current/framework/_category_.json | 4 ++++ .../1-kafka.md => framework/connector/1.kafka.md} | 0 .../2-jdbc.md => framework/connector/2.jdbc.md} | 0 .../connector/3.clickhouse.md} | 0 .../4-doris.md => framework/connector/4.doris.md} | 0 .../{connector/5-es.md => framework/connector/5.es.md} | 0 .../6-hbase.md => framework/connector/6.hbase.md} | 0 .../7-http.md => framework/connector/7.http.md} | 0 .../8-redis.md => framework/connector/8.redis.md} | 0 .../current/framework/connector/_category_.json | 4 ++++ .../current/{intro.md => get-started/1.intro.md} | 2 +- .../1-deployment.md => get-started/2.deployment.md} | 6 +++--- .../3.dockerDeployment.md} | 6 +++--- .../4.platformBasicUsage.md} | 8 ++++++-- .../current/get-started/_category_.json | 4 ++++ .../{development/alert-conf.md => platform/1.alert.md} | 4 ++-- .../10.hadoop-resource-integration.md} | 0 .../11.k8s-pvc-integration.md} | 0 .../{user-guide/5-LDAP.md => platform/2.LDAP.md} | 8 ++++---- .../20.version-upgrade.md} | 2 +- .../{user-guide/6-Team.md => platform/3.team.md} | 4 ++-- .../7-Variable.md => platform/4.variable.md} | 4 ++-- .../9-ExternalLink.md => platform/5.external-link.md} | 6 +++--- .../current/{user-guide/10-SSO.md => platform/6.SSO.md} | 6 +++--- .../7.-yarnQueue.md} | 2 +- .../8.platform-install.md} | 8 +++++++- .../1-deployment.md => platform/9.flink-on-k8s.md} | 4 ++-- .../current/platform/_category_.json | 4 ++++ .../current/user-guide/_category_.json | 4 ---- .../current/user-guide/img.png | Bin 57117 -> 0 bytes 74 files changed, 128 insertions(+), 99 deletions(-) diff --git a/docs/connector/_category_.json b/docs/connector/_category_.json deleted file mode 100644 index 4dfee890..00000000 --- a/docs/connector/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "DataStream Connector", - "position": 4 -} \ No newline at end of file diff --git a/docs/user-guide/3-development.md b/docs/development/1.development.md old mode 100755 new mode 100644 similarity index 100% rename from docs/user-guide/3-development.md rename to docs/development/1.development.md diff --git a/docs/development/_category_.json b/docs/development/_category_.json index 499cc5c7..c8a504ac 100644 --- a/docs/development/_category_.json +++ b/docs/development/_category_.json @@ -1,4 +1,4 @@ { - "label": "Development framework", + "label": "Development Guide", "position": 3 -} \ No newline at end of file +} diff --git a/docs/flink-k8s/_category_.json b/docs/flink-k8s/_category_.json deleted file mode 100644 index 32815c39..00000000 --- a/docs/flink-k8s/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Deployment", - "position": 7 -} \ No newline at end of file diff --git a/docs/development/model.md b/docs/framework/1.model.md similarity index 99% rename from docs/development/model.md rename to docs/framework/1.model.md index 809e61d9..8d4133c2 100644 --- a/docs/development/model.md +++ b/docs/framework/1.model.md @@ -1,5 +1,5 @@ --- -id: 'Programming-paradigm' +id: 'programming-paradigm' title: 'Programming Paradigm' sidebar_position: 1 --- diff --git a/docs/development/conf.md b/docs/framework/2.conf.md similarity index 99% rename from docs/development/conf.md rename to docs/framework/2.conf.md index 3c8b1a30..0b43c707 100755 --- a/docs/development/conf.md +++ b/docs/framework/2.conf.md @@ -1,6 +1,6 @@ --- id: 'config' -title: 'Project Configuration' +title: 'Project configuration' sidebar_position: 2 --- diff --git a/docs/user-guide/2-quickstart.md b/docs/framework/3.quickstart.md similarity index 98% rename from docs/user-guide/2-quickstart.md rename to docs/framework/3.quickstart.md index 160dc264..757fd402 100644 --- a/docs/user-guide/2-quickstart.md +++ b/docs/framework/3.quickstart.md @@ -1,7 +1,7 @@ --- id: 'quick-start' -title: 'Quick Start' -sidebar_position: 2 +title: 'Quick start' +sidebar_position: 3 --- ## How to use diff --git a/docs/framework/_category_.json b/docs/framework/_category_.json new file mode 100644 index 00000000..0783fc65 --- /dev/null +++ b/docs/framework/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Development Framework", + "position": 3 +} diff --git a/docs/connector/1-kafka.md b/docs/framework/connector/1.kafka.md similarity index 100% rename from docs/connector/1-kafka.md rename to docs/framework/connector/1.kafka.md diff --git a/docs/connector/2-jdbc.md b/docs/framework/connector/2.jdbc.md similarity index 100% rename from docs/connector/2-jdbc.md rename to docs/framework/connector/2.jdbc.md diff --git a/docs/connector/3-clickhouse.md b/docs/framework/connector/3.clickhouse.md similarity index 100% rename from docs/connector/3-clickhouse.md rename to docs/framework/connector/3.clickhouse.md diff --git a/docs/connector/4-doris.md b/docs/framework/connector/4.doris.md similarity index 100% rename from docs/connector/4-doris.md rename to docs/framework/connector/4.doris.md diff --git a/docs/connector/5-es.md b/docs/framework/connector/5.es.md similarity index 100% rename from docs/connector/5-es.md rename to docs/framework/connector/5.es.md diff --git a/docs/connector/6-hbase.md b/docs/framework/connector/6.hbase.md similarity index 100% rename from docs/connector/6-hbase.md rename to docs/framework/connector/6.hbase.md diff --git a/docs/connector/7-http.md b/docs/framework/connector/7.http.md similarity index 100% rename from docs/connector/7-http.md rename to docs/framework/connector/7.http.md diff --git a/docs/connector/8-redis.md b/docs/framework/connector/8.redis.md similarity index 100% rename from docs/connector/8-redis.md rename to docs/framework/connector/8.redis.md diff --git a/docs/framework/connector/_category_.json b/docs/framework/connector/_category_.json new file mode 100644 index 00000000..e70a4af1 --- /dev/null +++ b/docs/framework/connector/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Connectors", + "position": 4 +} diff --git a/docs/intro.md b/docs/get-started/1.intro.md similarity index 100% rename from docs/intro.md rename to docs/get-started/1.intro.md diff --git a/docs/user-guide/1-deployment.md b/docs/get-started/2.deployment.md similarity index 98% rename from docs/user-guide/1-deployment.md rename to docs/get-started/2.deployment.md index 735af1f3..7646ebfd 100755 --- a/docs/user-guide/1-deployment.md +++ b/docs/get-started/2.deployment.md @@ -1,7 +1,7 @@ --- id: 'deployment' title: 'Platform Deployment' -sidebar_position: 1 +sidebar_position: 2 --- import { DeploymentEnvs } from '../components/TableData.jsx'; @@ -37,7 +37,7 @@ export HADOOP_YARN_HOME=$HADOOP_HOME/../hadoop-yarn ### Kubernetes -Using `Flink on Kubernetes` requires additional deployment or use of an existing Kubernetes cluster. Refer to the entry: [**StreamPark Flink-K8s Integration Support**](../flink-k8s/1-deployment.md). +Using `Flink on Kubernetes` requires additional deployment or use of an existing Kubernetes cluster. Refer to the entry: [**StreamPark Flink-K8s Integration Support**](../platform/10-hadoop-resource-integration.md) ## Build & Deploy diff --git a/docs/user-guide/4-dockerDeployment.md b/docs/get-started/3.dockerDeployment.md similarity index 98% rename from docs/user-guide/4-dockerDeployment.md rename to docs/get-started/3.dockerDeployment.md index a53edc14..c41a0bca 100644 --- a/docs/user-guide/4-dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -1,10 +1,10 @@ --- id: 'docker-deployment' -title: 'Docker Tutorial' -sidebar_position: 4 +title: 'Platform Deployment using Docker' +sidebar_position: 3 --- -This tutorial uses the docker method to deploy StreamPark via Docker. +This tutorial for docker deploy StreamPark ## Prepare Docker 1.13.1+ diff --git a/docs/user-guide/12-platformBasicUsage.md b/docs/get-started/4.platformBasicUsage.md similarity index 99% rename from docs/user-guide/12-platformBasicUsage.md rename to docs/get-started/4.platformBasicUsage.md index 4ad160a1..d4de73eb 100644 --- a/docs/user-guide/12-platformBasicUsage.md +++ b/docs/get-started/4.platformBasicUsage.md @@ -1,3 +1,9 @@ +--- +id: 'how-to-use' +title: 'How to Use Platform' +sidebar_position: 4 +--- + # Quick Start > Note: This section is designed to provide a convenient process for > submitting Flink jobs using the StreamPark platform through simple > operational steps. @@ -309,7 +315,6 @@ flink run-application -t yarn-application \ ### Native Flink Job Status > Reference: > [https://nightlies.apache.org/flink/flink-docs-release-1.17/docs/internals/job_scheduling/#jobmanager-data-structures](https://nightlies.apache.org/flink/flink-docs-release-1.17/docs/internals/job_scheduling/#jobmanager-data-structures) - ### Job Status in Apache StreamPark™ > 【**To be improved**】 diff --git a/docs/get-started/_category_.json b/docs/get-started/_category_.json new file mode 100644 index 00000000..1bf165d4 --- /dev/null +++ b/docs/get-started/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Get Started", + "position": 1 +} diff --git a/docs/development/alert-conf.md b/docs/platform/1.alert.md similarity index 99% rename from docs/development/alert-conf.md rename to docs/platform/1.alert.md index b0680357..3b89b436 100644 --- a/docs/development/alert-conf.md +++ b/docs/platform/1.alert.md @@ -1,7 +1,7 @@ --- -id: 'alert-conf' +id: 'alert' title: 'Alert Configuration' -sidebar_position: 3 +sidebar_position: 1 --- import Tabs from '@theme/Tabs'; diff --git a/docs/flink-k8s/3-hadoop-resource-integration.md b/docs/platform/10.hadoop-resource-integration.md similarity index 99% rename from docs/flink-k8s/3-hadoop-resource-integration.md rename to docs/platform/10.hadoop-resource-integration.md index 049a415e..3b014499 100644 --- a/docs/flink-k8s/3-hadoop-resource-integration.md +++ b/docs/platform/10.hadoop-resource-integration.md @@ -1,7 +1,7 @@ --- id: 'hadoop-resource-integration' -title: 'Hadoop Resource Integration' -sidebar_position: 3 +title: 'Using Hadoop Resource in Flink on Kubernetes' +sidebar_position: 10 --- ## Using Apache Hadoop resource in Flink on Kubernetes diff --git a/docs/flink-k8s/2-k8s-pvc-integration.md b/docs/platform/11.k8s-pvc-integration.md similarity index 96% rename from docs/flink-k8s/2-k8s-pvc-integration.md rename to docs/platform/11.k8s-pvc-integration.md index 3ed1d97f..f3f716cf 100755 --- a/docs/flink-k8s/2-k8s-pvc-integration.md +++ b/docs/platform/11.k8s-pvc-integration.md @@ -1,7 +1,7 @@ --- id: 'k8s-pvc-integration' -title: 'Kubernetes PVC Resource usage' -sidebar_position: 2 +title: 'Kubernetes PVC Resource Usage' +sidebar_position: 11 --- ## Resource usage instructions of K8s PVC diff --git a/docs/user-guide/5-LDAP.md b/docs/platform/2.LDAP.md similarity index 95% rename from docs/user-guide/5-LDAP.md rename to docs/platform/2.LDAP.md index c9fe57e8..e42906cb 100644 --- a/docs/user-guide/5-LDAP.md +++ b/docs/platform/2.LDAP.md @@ -1,7 +1,7 @@ --- -id: 'LDAP' -title: 'LDAP Tutorial' -sidebar_position: 5 +id: 'ldap' +title: 'LDAP Integration' +sidebar_position: 2 --- ## LDAP Introduction @@ -47,4 +47,4 @@ ldap: ## User matches the Key value of the user's mailbox email: attribute: mail -``` \ No newline at end of file +``` diff --git a/docs/user-guide/13-version-upgrade.md b/docs/platform/20.version-upgrade.md similarity index 99% rename from docs/user-guide/13-version-upgrade.md rename to docs/platform/20.version-upgrade.md index 7e6383fe..6f7b6f6e 100644 --- a/docs/user-guide/13-version-upgrade.md +++ b/docs/platform/20.version-upgrade.md @@ -1,7 +1,7 @@ --- id: 'version-upgrade' title: 'Version Upgrade Guide' -sidebar_position: 13 +sidebar_position: 20 --- ### Pre-Upgrade Preparation diff --git a/docs/user-guide/6-Team.md b/docs/platform/3.team.md similarity index 98% rename from docs/user-guide/6-Team.md rename to docs/platform/3.team.md index 328e93b0..595b82f3 100644 --- a/docs/user-guide/6-Team.md +++ b/docs/platform/3.team.md @@ -1,7 +1,7 @@ --- -id: 'Team' +id: 'team' title: 'Team & member Management' -sidebar_position: 6 +sidebar_position: 3 --- ## User Management diff --git a/docs/user-guide/7-Variable.md b/docs/platform/4.variable.md similarity index 98% rename from docs/user-guide/7-Variable.md rename to docs/platform/4.variable.md index c2e774a4..a984910a 100644 --- a/docs/user-guide/7-Variable.md +++ b/docs/platform/4.variable.md @@ -1,7 +1,7 @@ --- -id: 'Variable' +id: 'variable' title: 'Variable Management' -sidebar_position: 7 +sidebar_position: 4 --- ## Background Introduction diff --git a/docs/user-guide/9-ExternalLink.md b/docs/platform/5.external-link.md similarity index 94% rename from docs/user-guide/9-ExternalLink.md rename to docs/platform/5.external-link.md index 58585f4d..e0bb6048 100644 --- a/docs/user-guide/9-ExternalLink.md +++ b/docs/platform/5.external-link.md @@ -1,7 +1,7 @@ --- -id: 'ExternalLink' +id: 'ext-link' title: 'External Link Management' -sidebar_position: 9 +sidebar_position: 5 --- ## Background @@ -19,4 +19,4 @@ In the detail page, each link consists of label(optional), name, color and link. ## Where can see the external link After the Flink job starts, you can go to the `Application` module, and click the Flink job from the list page. After that, all the defined badges will be displayed on the top of the detail page, and upon click, request will be redirected to desired external service page. -<img src="/doc/image/external-link/badge.png"/><br></br> \ No newline at end of file +<img src="/doc/image/external-link/badge.png"/><br></br> diff --git a/docs/user-guide/10-SSO.md b/docs/platform/6.SSO.md similarity index 99% rename from docs/user-guide/10-SSO.md rename to docs/platform/6.SSO.md index 5cabaa7f..176f09ca 100644 --- a/docs/user-guide/10-SSO.md +++ b/docs/platform/6.SSO.md @@ -1,7 +1,7 @@ --- -id: 'SSO' +id: 'sso' title: 'SSO Integration' -sidebar_position: 10 +sidebar_position: 6 --- ## Background @@ -89,4 +89,4 @@ pac4j: </exclusion> </exclusions> </dependency> -``` \ No newline at end of file +``` diff --git a/docs/user-guide/8-YarnQueueManagement.md b/docs/platform/7.yarnQueue.md similarity index 99% rename from docs/user-guide/8-YarnQueueManagement.md rename to docs/platform/7.yarnQueue.md index 2b361229..3aae8447 100644 --- a/docs/user-guide/8-YarnQueueManagement.md +++ b/docs/platform/7.yarnQueue.md @@ -1,7 +1,7 @@ --- -id: 'YarnQueueManagement' +id: 'yarn-queue' title: 'Yarn Queue Management' -sidebar_position: 8 +sidebar_position: 7 --- ## Background diff --git a/docs/user-guide/11-platformInstall.md b/docs/platform/8.platform-build.md similarity index 99% rename from docs/user-guide/11-platformInstall.md rename to docs/platform/8.platform-build.md index e6d830e5..da71dc05 100644 --- a/docs/user-guide/11-platformInstall.md +++ b/docs/platform/8.platform-build.md @@ -1,3 +1,9 @@ +--- +id: 'platform-install' +title: 'How to Build Platform' +sidebar_position: 8 +--- + # Platform Installation Introduction ## Purpose and Scope > This document aims to assist users in installing and initially configuring > Apache StreamPark. diff --git a/docs/flink-k8s/1-deployment.md b/docs/platform/9.flink-on-k8s.md similarity index 99% rename from docs/flink-k8s/1-deployment.md rename to docs/platform/9.flink-on-k8s.md index b8f310f3..1daf7874 100644 --- a/docs/flink-k8s/1-deployment.md +++ b/docs/platform/9.flink-on-k8s.md @@ -1,7 +1,7 @@ --- -id: 'k8s-dev' -title: 'Flink on K8s ' -sidebar_position: 1 +id: 'flink-on-k8s' +title: 'Flink on Kubernetes' +sidebar_position: 9 --- diff --git a/docs/platform/_category_.json b/docs/platform/_category_.json new file mode 100644 index 00000000..cd2edb78 --- /dev/null +++ b/docs/platform/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Platform User Guide", + "position": 2 +} diff --git a/docs/user-guide/_category_.json b/docs/user-guide/_category_.json deleted file mode 100644 index 1234b4ba..00000000 --- a/docs/user-guide/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "User guide", - "position": 2 -} \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 57d787a5..6c27df96 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -110,7 +110,7 @@ const config = { }, items: [ { - to: '/docs/intro', + to: '/docs/get-started/intro', label: 'Docs', position: "right", activeBaseRegex: `/docs`, diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/_category_.json deleted file mode 100644 index 4dfee890..00000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "DataStream Connector", - "position": 4 -} \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/3-development.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/1.development.md old mode 100755 new mode 100644 similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/3-development.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/development/1.development.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/_category_.json index fb39c780..82a356a3 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/_category_.json +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/_category_.json @@ -1,4 +1,4 @@ { - "label": "极速开发", + "label": "开发手册", "position": 3 -} \ No newline at end of file +} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/_category_.json deleted file mode 100644 index 32815c39..00000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Deployment", - "position": 7 -} \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/model.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/1.model.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/development/model.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/1.model.md index bec708e7..ba8c194f 100755 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/model.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/1.model.md @@ -25,11 +25,11 @@ import TabItem from '@theme/TabItem'; ## 编程模型 -`streampark-core` 定位是编程时框架,快速开发脚手架,专门为简化 Flink 开发而生,开发者在开发阶段会使用到该模块,下面我们来看看 `DataStream` 和 `Flink Sql` 用 StreamPark 来开发编程模型是什么样的,有什么规范和要求 +`streampark-core` 是快速开发框架,专门为简化 Flink 开发而生,开发者在开发阶段会使用到该模块,下面我们来看看 `DataStream` 和 `Flink Sql` 用 StreamPark 来开发编程模型是什么样的,有什么规范和要求 ### DataStream - StreamPark 提供了`scala`和`Java`两种 API 来开发 `DataStream` 程序,具体代码开发如下 + StreamPark 提供了 Scala 和 Java 两种 API 来开发 `DataStream` 程序，具体代码开发如下 <Tabs> <TabItem value="scala" label="Scala" default> diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/conf.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/2.conf.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/development/conf.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/2.conf.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/2-quickstart.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/3.quickstart.md similarity index 88% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/2-quickstart.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/3.quickstart.md index 5efb2d32..ac9e89a3 100755 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/2-quickstart.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/3.quickstart.md @@ -1,12 +1,12 @@ --- id: 'quick-start' title: '快速开始' -sidebar_position: 2 +sidebar_position: 3 --- ## 如何使用 -在上个章节已经详细介绍了一站式平台 `streampark-console` 的安装, 本章节看看如果用 `streampark-console` 快速部署运行一个作业, `streampark-console` 对标准的 Flink 程序 ( 按照 Flink 官方要求的结构和规范 ) 和用 `streampark` 开发的项目都做了很好的支持，下面我们使用 `streampark-quickstart` 来快速开启 `streampark-console` 之旅 +这个章节主要讲如何使用 StreamPark 提供的开发框架，完成作业的开发， 我们使用 `streampark-quickstart` 来快速开启 Flink 作业的快速开发之旅 `streampark-quickstart` 是 StreamPark 开发 Flink 的上手示例程序，具体请查阅: diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/_category_.json new file mode 100644 index 00000000..a672a3a8 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "开发框架使用手册", + "position": 3 +} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/1-kafka.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/1.kafka.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/1-kafka.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/1.kafka.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/2-jdbc.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/2.jdbc.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/2-jdbc.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/2.jdbc.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/3-clickhouse.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/3.clickhouse.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/3-clickhouse.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/3.clickhouse.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/4-doris.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/4.doris.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/4-doris.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/4.doris.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/5-es.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/5.es.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/5-es.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/5.es.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/6-hbase.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/6.hbase.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/6-hbase.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/6.hbase.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/7-http.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/7.http.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/7-http.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/7.http.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/8-redis.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/8.redis.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/connector/8-redis.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/8.redis.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/_category_.json new file mode 100644 index 00000000..2aaa53e2 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/framework/connector/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "开箱即用的连接器", + "position": 4 +} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/intro.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/1.intro.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/intro.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/1.intro.md index 4443b2cd..891daec7 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/intro.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/1.intro.md @@ -1,6 +1,6 @@ --- id: 'intro' -title: '框架介绍' +title: '什么是 Apache StreamPark' sidebar_position: 1 --- diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/1-deployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/2.deployment.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/1-deployment.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/2.deployment.md index 1dfec80b..df115431 100755 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/1-deployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/2.deployment.md @@ -1,7 +1,7 @@ --- id: 'deployment' -title: '安装部署' -sidebar_position: 1 +title: '平台安装部署' +sidebar_position: 2 --- import { DeploymentEnvs } from '../components/TableData.jsx'; @@ -34,7 +34,7 @@ export HADOOP_YARN_HOME=$HADOOP_HOME/../hadoop-yarn ### Kubernetes -使用 `Flink on Kubernetes`，需要额外部署/或使用已经存在的 Kubernetes 集群，请参考条目： [**StreamPark Flink-K8s 集成支持**](../flink-k8s/1-deployment.md)。 +使用 `Flink on Kubernetes`，需要额外部署/或使用已经存在的 Kubernetes 集群，请参考条目： [**StreamPark Flink-K8s 集成支持**](../platform/10-hadoop-resource-integration.md) ## 安装 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/4-dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/4-dockerDeployment.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 7cf9b08b..a90971f1 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/4-dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -1,10 +1,10 @@ --- id: 'docker-deployment' -title: 'Docker 部署' -sidebar_position: 4 +title: 'Docker 部署平台' +sidebar_position: 3 --- -本教程使用 Docker 完成 StreamPark 的部署。 +本教程使用 Docker 完成 StreamPark 平台的部署。 ## 前置条件 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/12-platformBasicUsage.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/4.platformBasicUsage.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/12-platformBasicUsage.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/4.platformBasicUsage.md index b3e8aec2..b64cfa59 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/12-platformBasicUsage.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/4.platformBasicUsage.md @@ -1,3 +1,9 @@ +--- +id: 'how-to-use' +title: '平台使用手册' +sidebar_position: 4 +--- + # 快速上手 > 说明：该部分旨在通过简单的操作步骤，体验使用StreamPark平台提交flink作业的便捷流程。 @@ -323,8 +329,6 @@ flink run-application -t yarn-application \ ### 原生flink 作业状态 > 参考：[https://nightlies.apache.org/flink/flink-docs-release-1.14/zh/docs/internals/job_scheduling/#jobmanager-%e6%95%b0%e6%8d%ae%e7%bb%93%e6%9e%84](https://nightlies.apache.org/flink/flink-docs-release-1.14/zh/docs/internals/job_scheduling/#jobmanager-%e6%95%b0%e6%8d%ae%e7%bb%93%e6%9e%84) - - ### Apache StreamPark™中的作业状态 > 【**待完善**】 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/_category_.json new file mode 100644 index 00000000..27c29d98 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "快速上手", + "position": 1 +} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/1.alert.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/1.alert.md index 96182e15..612ec6fd 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/1.alert.md @@ -1,7 +1,7 @@ --- -id: 'alert-conf' +id: 'alert' title: '报警配置' -sidebar_position: 3 +sidebar_position: 1 --- import Tabs from '@theme/Tabs'; diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/3-hadoop-resource-integration.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/10.hadoop-resource-integration.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/3-hadoop-resource-integration.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/10.hadoop-resource-integration.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/2-k8s-pvc-integration.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/11.k8s-pvc-integration.md similarity index 100% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/2-k8s-pvc-integration.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/11.k8s-pvc-integration.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/5-LDAP.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/2.LDAP.md similarity index 95% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/5-LDAP.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/2.LDAP.md index 9013c2c2..2d4a83bf 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/5-LDAP.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/2.LDAP.md @@ -1,7 +1,7 @@ --- -id: 'LDAP' -title: 'LDAP 使用' -sidebar_position: 5 +id: 'ldap' +title: 'LDAP 集成' +sidebar_position: 2 --- ## LDAP简介 @@ -49,4 +49,4 @@ ldap: ## 用户匹配用户的邮箱的Key值 email: attribute: mail -``` \ No newline at end of file +``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/20.version-upgrade.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/20.version-upgrade.md index 75962d12..cd8b3dfa 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/20.version-upgrade.md @@ -1,7 +1,7 @@ --- id: 'version-upgrade' title: '版本升级指南' -sidebar_position: 13 +sidebar_position: 20 --- ### 升级前准备 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/6-Team.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/3.team.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/6-Team.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/3.team.md index 8c8b8f03..2ffc857f 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/6-Team.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/3.team.md @@ -1,7 +1,7 @@ --- -id: 'Team' +id: 'team' title: '团队成员管理' -sidebar_position: 6 +sidebar_position: 3 --- ## 用户管理 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/7-Variable.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/4.variable.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/7-Variable.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/4.variable.md index fa2e1fa7..876f177e 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/7-Variable.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/4.variable.md @@ -1,7 +1,7 @@ --- -id: 'Variable' +id: 'variable' title: '变量管理' -sidebar_position: 7 +sidebar_position: 4 --- ## 背景介绍 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-ExternalLink.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/5.external-link.md similarity index 96% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-ExternalLink.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/5.external-link.md index 1f4c361e..61016ea6 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-ExternalLink.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/5.external-link.md @@ -1,7 +1,7 @@ --- -id: 'ExternalLink' -title: '扩展链接' -sidebar_position: 9 +id: 'ext-link' +title: '扩展链接设置' +sidebar_position: 5 --- ## 背景介绍 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/10-SSO.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/6.SSO.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/10-SSO.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/6.SSO.md index 9b1990ac..3194a2cb 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/10-SSO.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/6.SSO.md @@ -1,7 +1,7 @@ --- -id: 'SSO' +id: 'sso' title: 'SSO集成' -sidebar_position: 10 +sidebar_position: 6 --- ## 背景介绍 @@ -90,4 +90,4 @@ pac4j: </exclusion> </exclusions> </dependency> -``` \ No newline at end of file +``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/8-YarnQueueManagement.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/7.-yarnQueue.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/8-YarnQueueManagement.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/7.-yarnQueue.md index f069a9ad..c201b159 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/8-YarnQueueManagement.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/7.-yarnQueue.md @@ -1,5 +1,5 @@ --- -id: 'YarnQueueManagement' +id: 'yarn-queue' title: 'Yarn队列管理' sidebar_position: 8 --- diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/11-platformInstall.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/8.platform-install.md similarity index 98% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/11-platformInstall.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/8.platform-install.md index a0eb63e1..f044d45a 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/11-platformInstall.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/8.platform-install.md @@ -1,3 +1,9 @@ +--- +id: 'platform-install' +title: '如果构建编译' +sidebar_position: 8 +--- + # 平台安装介绍 ## 目的和范围 > 本文档旨在帮助用户完成 Apache StreamPark 的安装和初步配置 @@ -15,7 +21,7 @@ ## 软件要求 Notes: -1. **单纯安装StreamPark，可忽略hadoop** +1. **单纯安装 StreamPark，可忽略 Hadoop** 2. 若采用 yarn application 模式 执行flink作业，需要hadoop > - JDK : 1.8+ > - MySQL : 5.6+ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/9.flink-on-k8s.md similarity index 99% rename from i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md rename to i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/9.flink-on-k8s.md index 4d3f581d..fb2d0331 100755 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/9.flink-on-k8s.md @@ -1,6 +1,6 @@ --- -id: 'k8s-dev' -title: 'Flink K8s 集成支持' +id: 'flink-on-k8s' +title: 'Flink on Kubernetes' sidebar_position: 1 --- diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/_category_.json new file mode 100644 index 00000000..06a6ed86 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/platform/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "平台使用手册", + "position": 2 +} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/_category_.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/_category_.json deleted file mode 100644 index acc45127..00000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "用户手册", - "position": 2 -} \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/img.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/img.png deleted file mode 100644 index 369de2e8..00000000 Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/img.png and /dev/null differ
