| /* |
| * 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. |
| */ |
| |
| /** |
| * Creating a sidebar enables you to: |
| - create an ordered group of docs |
| - render a sidebar for each doc of that group |
| - provide next/previous navigation |
| |
| The sidebars can be generated from the filesystem, or explicitly defined here. |
| |
| Create as many sidebars as you want. |
| */ |
| |
| // @ts-check |
| |
| /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ |
| const sidebars = { |
| // 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": [ |
| "about", |
| { |
| "type": "category", |
| "label": "Quick Start - V2", |
| "items": [ |
| { |
| "type": "category", |
| "label": "Start With Locally", |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "start-v2/locally" |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Start With Docker", |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "start-v2/docker" |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Start With K8s", |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "start-v2/kubernetes" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Concepts", |
| "items": [ |
| "concept/config", |
| "concept/connector-v2-features", |
| 'concept/schema-feature', |
| 'concept/JobEnvConfig', |
| 'concept/sink-options-placeholders', |
| 'concept/sql-config', |
| 'concept/speed-limit', |
| 'concept/event-listener', |
| 'concept/schema-evolution', |
| 'concept/metalake' |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Connector-V2", |
| "items": [ |
| { |
| "type": "category", |
| "label": "Source", |
| "link": { |
| "type": "generated-index", |
| "title": "Source(V2) of SeaTunnel", |
| "description": "List all source(v2) supported by Apache SeaTunnel for now.", |
| "slug": "/connector-v2/source", |
| "keywords": ["source"], |
| "image": "/img/favicon.ico" |
| }, |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "connector-v2/source" |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Sink", |
| "link": { |
| "type": "generated-index", |
| "title": "Sink(V2) of SeaTunnel", |
| "description": "List all sink(v2) supported by Apache SeaTunnel for now.", |
| "slug": "/connector-v2/sink", |
| "keywords": ["sink"], |
| "image": "/img/favicon.ico" |
| }, |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "connector-v2/sink" |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Formats", |
| "link": { |
| "type": "generated-index", |
| "title": "Formats", |
| "description": "List some special formats (not all) supported by Apache SeaTunnel for now.", |
| "slug": "/connector-v2/formats", |
| "keywords": ["formats"], |
| "image": "/img/favicon.ico" |
| }, |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "connector-v2/formats" |
| } |
| ] |
| }, |
| "connector-v2/source-common-options", |
| "connector-v2/sink-common-options", |
| "connector-v2/connector-isolated-dependency", |
| "connector-v2/Error-Quick-Reference-Manual", |
| "connector-v2/Config-Encryption-Decryption" |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Transform-V2", |
| "link": { |
| "type": "generated-index", |
| "title": "Transform V2 of SeaTunnel", |
| "description": "List all transform v2 supported Apache SeaTunnel for now.", |
| "slug": "/transform-v2", |
| "keywords": ["transform-v2"], |
| "image": "/img/favicon.ico" |
| }, |
| "items": [ |
| { |
| "type": "autogenerated", |
| "dirName": "transform-v2" |
| } |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Command", |
| "items": [ |
| "command/usage", |
| "command/connector-check" |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "SeaTunnel Engine", |
| "items": [ |
| "seatunnel-engine/about", |
| { |
| "type": "category", |
| "label": "Deployment", |
| "items": [ |
| "seatunnel-engine/download-seatunnel", |
| "seatunnel-engine/deployment", |
| "seatunnel-engine/local-mode-deployment", |
| "seatunnel-engine/hybrid-cluster-deployment", |
| "seatunnel-engine/separated-cluster-deployment" |
| ] |
| }, |
| "seatunnel-engine/savepoint", |
| "seatunnel-engine/checkpoint-storage", |
| "seatunnel-engine/engine-jar-storage-mode", |
| "seatunnel-engine/tcp", |
| "seatunnel-engine/resource-isolation", |
| { |
| "type": "category", |
| "label": "RESTFul API", |
| "items": [ |
| "seatunnel-engine/rest-api-v1", |
| "seatunnel-engine/rest-api-v2", |
| "seatunnel-engine/security" |
| ] |
| }, |
| "seatunnel-engine/user-command", |
| "seatunnel-engine/logging", |
| "seatunnel-engine/telemetry", |
| "seatunnel-engine/web-ui", |
| "seatunnel-engine/slot-allocation-strategy", |
| "seatunnel-engine/tuning-guide" |
| ] |
| }, |
| { |
| "type": "category", |
| "label": "Other Engine", |
| "items": [ |
| "other-engine/flink", |
| "other-engine/spark" |
| ] |
| }, |
| { |
| type: 'category', |
| label: 'Contribution', |
| items: [ |
| 'contribution/setup', |
| 'contribution/new-license', |
| 'contribution/coding-guide', |
| 'contribution/contribute-transform-v2-guide', |
| 'contribution/how-to-create-your-connector', |
| 'contribution/docs-format-specification' |
| ], |
| }, |
| "faq" |
| ] |
| }; |
| |
| module.exports = sidebars |
