[incubator-seatunnel] branch dev updated: [doc] Move sidebars.js from website repo (#1586)

[ki...@apache.org]

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

kirs 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 a40c0a4  [doc] Move sidebars.js from website repo (#1586)
a40c0a4 is described below

commit a40c0a427cc24d7dfe85dadb45906fbbdd9e72db
Author: Jiajie Zhong <zh...@hotmail.com>
AuthorDate: Sun Mar 27 19:35:49 2022 +0800

    [doc] Move sidebars.js from website repo (#1586)
    
    This patch try to make the docs and sidebar config together,
    which make developers could add/change our docs in one single
    PR instead of separate, same as #1563,
---
 docs/sidebars.js | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 120 insertions(+)

diff --git a/docs/sidebars.js b/docs/sidebars.js
new file mode 100644
index 0000000..120df81
--- /dev/null
+++ b/docs/sidebars.js
@@ -0,0 +1,120 @@
+/*
+ * 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: [
+    'introduction',
+    {
+      type: 'category',
+      label: 'Spark',
+      items: [
+        'spark/installation',
+        'spark/quick-start',
+        'spark/deployment',
+        {
+          type: 'category',
+          label: 'Configuration',
+          items: [
+            // TODO we can use generated-index to create some leading page like https://docusaurus.io/docs/category/guides
+            {
+              type: 'autogenerated',
+              dirName: 'spark/configuration',
+            },
+          ],
+        },
+        {
+          type: 'category',
+          label: 'Commands',
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: 'spark/commands',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Flink',
+      items: [
+        'flink/installation',
+        'flink/quick-start',
+        'flink/deployment',
+        {
+          type: 'category',
+          label: 'Configuration',
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: 'flink/configuration',
+            },
+          ],
+        },
+        {
+          type: 'category',
+          label: 'Commands',
+          items: [
+            {
+              type: 'autogenerated',
+              dirName: 'flink/commands',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      type: 'category',
+      label: 'developement',
+      items: [
+        'developement/setup',
+        'developement/NewLicenseGuide',
+      ],
+    },
+    'FAQ',
+  ]
+};
+
+module.exports = sidebars