You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by ki...@apache.org on 2022/03/24 12:15:13 UTC
[incubator-seatunnel-website] branch main updated: Change current doc structure (#91)
This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel-website.git
The following commit(s) were added to refs/heads/main by this push:
new e79db36 Change current doc structure (#91)
e79db36 is described below
commit e79db361c80b29636c68fcd8897f759696b5800f
Author: Jiajie Zhong <zh...@hotmail.com>
AuthorDate: Thu Mar 24 20:14:04 2022 +0800
Change current doc structure (#91)
---
README.md | 1 +
README_ZH.md | 1 +
docusaurus.config.js | 3 ++
sidebars.js | 76 ++++++++++++++++++++++++++++++++++++-
sidebars.js => sidebarsCommunity.js | 4 +-
5 files changed, 81 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ec69d4f..aa7bf1c 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,7 @@ This website is compiled using node, using Docusaurus framework components
│ └── docusaurus-theme-classic
├── package.json
├── sidebars.js
+├── sidebarsCommunity.js
├── src
│ ├── components
│ ├── css
diff --git a/README_ZH.md b/README_ZH.md
index 6bf6907..f76bfda 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -52,6 +52,7 @@ asf-staging 官网测试环境 通过https://seatunnel.staged.apache.org 访问
│ └── docusaurus-theme-classic
├── package.json
├── sidebars.js
+├── sidebarsCommunity.js
├── src
│ ├── components
│ ├── css
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 72741a2..1bafc3e 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -33,6 +33,9 @@ const config = {
'classic',
({
docs: {
+ id: 'docs',
+ path: 'docs',
+ routeBasePath: 'docs',
sidebarPath: require.resolve('./sidebars.js'),
sidebarCollapsible: true,
editLocalizedFiles: true,
diff --git a/sidebars.js b/sidebars.js
index fd342f2..9058522 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -14,7 +14,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
- tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+ // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
@@ -26,6 +26,78 @@ const sidebars = {
},
],
*/
+
+ 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;
+module.exports = sidebars
diff --git a/sidebars.js b/sidebarsCommunity.js
similarity index 91%
copy from sidebars.js
copy to sidebarsCommunity.js
index fd342f2..cfbffe1 100644
--- a/sidebars.js
+++ b/sidebarsCommunity.js
@@ -12,7 +12,7 @@
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+const sidebarsCommunity = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
@@ -28,4 +28,4 @@ const sidebars = {
*/
};
-module.exports = sidebars;
+module.exports = sidebarsCommunity;