blob: eda13f8e2907b005b6d2e890c5c6002c3f995d6a [file]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
"docs": [
{
"type": "category",
"label": "Introduction",
"items": [
"introduction/about",
"introduction/how-it-works",
{
"type": "category",
"label": "Concepts",
"items": [
"introduction/concepts/connector-v2-features",
"introduction/concepts/schema-feature"
]
}
]
},
{
"type": "category",
"label": "Getting Started",
"items": [
"getting-started/overview",
{
"type": "category",
"label": "Locally",
"link": {
"type": "doc",
"id": "getting-started/locally/overview"
},
"items": [
"getting-started/locally/run-your-first-job",
"getting-started/locally/deployment",
"getting-started/locally/quick-start-seatunnel-engine",
"getting-started/locally/quick-start-flink",
"getting-started/locally/quick-start-spark"
]
},
{
"type": "category",
"label": "Docker",
"items": [
"getting-started/docker/docker"
]
},
{
"type": "category",
"label": "Kubernetes",
"items": [
"getting-started/kubernetes/kubernetes",
"getting-started/kubernetes/helm"
]
}
]
},
{
"type": "category",
"label": "Configuration",
"items": [
"introduction/concepts/config",
"getting-started/job-configuration-guide",
"introduction/configuration/JobEnvConfig",
"introduction/configuration/sql-config",
"introduction/configuration/config-encryption-decryption",
"introduction/configuration/metalake",
"introduction/configuration/sink-options-placeholders",
"introduction/configuration/schema-evolution",
"introduction/configuration/speed-limit"
]
},
{
"type": "category",
"label": "Connectors",
"link": {
"type": "doc",
"id": "connectors/overview"
},
"items": [
{
"type": "category",
"label": "Source",
"link": {
"type": "doc",
"id": "connectors/source-overview"
},
"items": [
{
"type": "autogenerated",
"dirName": "connectors/source"
}
]
},
{
"type": "category",
"label": "Sink",
"link": {
"type": "doc",
"id": "connectors/sink-overview"
},
"items": [
{
"type": "autogenerated",
"dirName": "connectors/sink"
}
]
},
{
"type": "category",
"label": "Common Options",
"items": [
"connectors/common-options/source-common-options",
"connectors/common-options/sink-common-options"
]
},
{
"type": "category",
"label": "Formats",
"link": {
"type": "doc",
"id": "connectors/formats/overview"
},
"items": [
{
"type": "autogenerated",
"dirName": "connectors/formats"
}
]
},
"connectors/cdc-production-cookbook",
{
"type": "category",
"label": "Scenario Recipes",
"link": {
"type": "doc",
"id": "getting-started/recipes/overview"
},
"items": [
"getting-started/recipes/mysql-cdc-to-doris",
"getting-started/recipes/jdbc-to-s3",
"getting-started/recipes/kafka-to-iceberg",
"getting-started/recipes/http-to-jdbc",
"getting-started/recipes/file-to-starrocks",
"getting-started/recipes/multi-table-cdc"
]
},
"connectors/connector-faq",
"connectors/connector-isolated-dependency"
]
},
{
"type": "category",
"label": "Transforms",
"link": {
"type": "doc",
"id": "transforms/overview"
},
"items": [
{
"type": "category",
"label": "Common Options",
"items": [
"transforms/common-options/common-options"
]
},
"transforms/calcite",
"transforms/calcite-udf",
"transforms/copy",
"transforms/data-validator",
"transforms/define-sink-type",
"transforms/dynamic-compile",
"transforms/embedding",
"transforms/field-mapper",
"transforms/field-rename",
"transforms/filter",
"transforms/filter-rowkind",
"transforms/jsonpath",
"transforms/llm",
"transforms/metadata",
"transforms/regexextract",
"transforms/replace",
"transforms/rowkind-extractor",
"transforms/split",
"transforms/sql",
"transforms/sql-functions",
"transforms/sql-udf",
"transforms/table-filter",
"transforms/table-merge",
"transforms/table-rename",
"transforms/transform-multi-table",
"transforms/multi-table-transform-and-join-boundary"
]
},
{
"type": "category",
"label": "Engines",
"items": [
"engines/overview",
"engines/event-listener",
{
"type": "category",
"label": "SeaTunnel Engine (Zeta)",
"items": [
"engines/zeta/about",
{
"type": "category",
"label": "Deployment",
"items": [
"engines/zeta/download-seatunnel",
"engines/zeta/deployment",
"engines/zeta/local-mode-deployment",
"engines/zeta/hybrid-cluster-deployment",
"engines/zeta/separated-cluster-deployment"
]
},
"engines/zeta/rest-api-and-web-ui",
"getting-started/submit-job-to-remote-zeta-cluster",
"engines/zeta/checkpoint-storage",
"engines/zeta/state-storage-and-recovery",
"engines/zeta/engine-jar-storage-mode",
"engines/zeta/tcp",
"engines/zeta/resource-isolation",
{
"type": "category",
"label": "REST API",
"items": [
"engines/zeta/rest-api-v1",
"engines/zeta/rest-api-v2",
"engines/zeta/rest-api-job-lifecycle",
"engines/zeta/security",
"engines/zeta/python-sdk"
]
},
"engines/zeta/user-command",
"engines/zeta/logging",
"engines/zeta/telemetry",
"engines/zeta/web-ui",
"engines/zeta/slot-allocation-strategy",
"engines/zeta/tuning-guide"
]
},
{
"type": "category",
"label": "Command",
"items": [
"engines/command/usage",
"engines/command/connector-check"
]
},
"engines/flink",
"engines/spark"
]
},
{
"type": "category",
"label": "Architecture",
"items": [
"architecture/overview",
"architecture/design-philosophy",
"architecture/configuration-and-option-system",
"architecture/core-api-design",
"architecture/transform-plugin-system",
"architecture/cdc-pipeline-architecture",
"architecture/data-format-handling",
"architecture/table-schema-and-type-system",
"architecture/plugin-discovery-and-class-loading",
{
"type": "category",
"label": "API Design",
"items": [
"architecture/api-design/source-architecture",
"architecture/api-design/sink-architecture",
"architecture/api-design/catalog-table",
"architecture/api-design/translation-layer",
"architecture/api-design/flink-translation-layer",
"architecture/api-design/spark-translation-layer"
]
},
{
"type": "category",
"label": "Engine",
"items": [
"architecture/engine/engine-architecture",
"architecture/engine/dag-execution",
"architecture/engine/resource-management"
]
},
{
"type": "category",
"label": "Fault Tolerance",
"items": [
"architecture/fault-tolerance/checkpoint-mechanism",
"architecture/fault-tolerance/exactly-once"
]
},
{
"type": "category",
"label": "Features",
"items": [
"architecture/features/multi-table"
]
}
]
},
{
"type": "category",
"label": "Tools",
"items": [
"tools/overview",
"tools/seatunnel-skill",
"tools/seatunnel-mcp",
"tools/x2seatunnel"
]
},
{
"type": "category",
"label": "Developer",
"items": [
"developer/setup",
"developer/contribution-path",
"developer/coding-guide",
"developer/how-to-create-your-connector",
"developer/source-connector-development",
"developer/sink-connector-development",
"developer/contribute-plugin",
"developer/contribute-transform-v2-guide",
"developer/docs-format-specification",
"developer/new-license"
]
},
"faq"
]
};
module.exports = sidebars;