Support docs latest version (#303)

* [Feature] Support docs latest version * Fix all version * Fix menu link active problem * Fix mixing jumping problem between old version and latest * Fix download release version * Rename docs key and doscConfig * Rename 'become a committer.md' to 'become-a-committer.md'
apache · Mar 1, 2021 · 27e1d2a46c64c075376fa98d6874d3714574b6ce · 27e1d2a
1 parent 7e406cf
commit 27e1d2a46c64c075376fa98d6874d3714574b6ce
Show file tree

Hide file tree

Showing 47 changed files with 201 additions and 253 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.docsite b/.docsite
diff --git a/.eslintrc b/.eslintrc
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ This project keeps all sources used for building up DolphinScheduler official we
 ## Prerequisite
 
 DolphinScheduler website is powered by [docsite](https://github.com/chengshiwen/docsite-ext).
+
 Please also make sure your node version is 10+, version lower than 10.x is not supported yet.
 
 ## Build instruction 

diff --git a/...y/en-us/development/become a committer.md → ...y/en-us/development/become-a-committer.md b/...y/en-us/development/become a committer.md → ...y/en-us/development/become-a-committer.md
diff --git a/community/en-us/development/document.md b/community/en-us/development/document.md
@@ -2,7 +2,6 @@
 
 Good documentation is critical for any type of software. Any contribution that can improve the DolphinScheduler documentation is welcome.
 
-
 ###  Get the document project.
 
 Documentation for the DolphinScheduler project is maintained in a separate [git repository](https://github.com/apache/incubator-dolphinscheduler-website).
@@ -15,33 +14,27 @@ git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-
 
 ### The document environment.
 
-The DolphinScheduler website is supported by [docsite](https://github.com/txd-team/docsite)
-
-If your docsite version is below "1.3.3", upgrade to "1.3.3".
+The DolphinScheduler website is supported by [docsite](https://github.com/chengshiwen/docsite-ext)
 
-Make sure that your node version is 10.x, docsite does not yet support versions higher than 10.x.
+Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x.
 
 ### Document build guide.
 
-1. Run the "npm install docsite-g" installation development tool.
+1. Run `npm install` in the root directory to install the dependencies.
 
-2. Run "npm i" in the root directory to install the dependencies.
+2. Run `npm run start` in the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
 
-3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080.
+3. Run `npm run build` to build source code into dist directory.
 
-4. Run "docsite build" to generate the source code for the document site.
+4. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your python version is 3 use :`python3 -m http.server 8000` instead.
 
-5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`.
-
-If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer.
+If the latest version of node is installed locally, consider using `nvm` to allow different versions of `node` to run on your computer.
 
 1. Refer to the [Instructions](http://nvm.sh) to install nvm.
 
-2. Run “nvm install v10.23.1” to install node v10.
-
-3. Run “nvm use v10.23.1” to switch the current working environment to node v10.
+2. Run `nvm install v10.23.1` to install node v10.
 
-4. Run `npm install docsite -g`
+3. Run `nvm use v10.23.1` to switch the current working environment to node v10.
 
 Now you can run and build the website in your local environment.
 

diff --git a/...y/zh-cn/development/become a committer.md → ...y/zh-cn/development/become-a-committer.md b/...y/zh-cn/development/become a committer.md → ...y/zh-cn/development/become-a-committer.md
diff --git a/community/zh-cn/development/document.md b/community/zh-cn/development/document.md
@@ -2,7 +2,6 @@
 
 良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进 DolphinScheduler 文档的贡献。
 
-
 ### 获取文档项目
 
 DolphinScheduler 项目的文档维护在独立的 [git 仓库](https://github.com/apache/incubator-dolphinscheduler-website)中。
@@ -15,33 +14,27 @@ git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-
 
 ### 文档环境
 
-DolphinScheduler 网站由 [docsite](https://github.com/txd-team/docsite) 提供支持。
-
-如果你的 docsite 版本低于 “1.3.3”，请升级到 “1.3.3”。
+DolphinScheduler 网站由 [docsite](https://github.com/chengshiwen/docsite-ext) 提供支持。
 
-请确保你的 node 版本是 10.x，docsite 尚不支持高于 10.x 的版本。
+请确保你的 node 版本是 10+，docsite 尚不支持高于 10.x 的版本。
 
 ### 文档构建指南
 
-1. 运行 “npm install docsite -g” 安装开发工具。
+1. 在根目录中运行 `npm install` 以安装依赖项。
 
-2. 在根目录中运行 “npm i” 以安装依赖项。
+2. 在根目录下运行 `npm run start` 启动本地服务器，其将允许在 http://127.0.0.1:8080。
 
-3. 在根目录下运行 “docsite start” 启动本地服务器，其将允许在 http://127.0.0.1:8080。
+3. 运行 `npm run build` 可以生成文档网站源代码。
 
-4. 运行 “docsite build” 可以生成文档网站源代码。
+4. 在本地验证你的更改：`python -m SimpleHTTPServer 8000`，当 python 版本为 3 时，请使用：`python3 -m http.server 8000`。
 
-5. 在本地验证你的更改：`python -m SimpleHTTPServer 8000`，当 python 版本为 3 时，请使用：`python3 -m http.server 8000`。
-
-如果本地安装了更高版本的 node，可以考虑使用 “nvm” 来允许不同版本的 node 在你的计算机上运行。
+如果本地安装了更高版本的 node，可以考虑使用 `nvm` 来允许不同版本的 `node` 在你的计算机上运行。
 
 1. 参考[说明](http://nvm.sh)安装 nvm
 
-2. 运行 “nvm install v10.23.1” 安装 node v10
-
-3. 运行 “nvm use v10.23.1” 将当前工作环境切换到 node v10
+2. 运行 `nvm install v10.23.1` 安装 node v10
 
-4. 运行 “npm install docsite-g“
+3. 运行 `nvm use v10.23.1` 将当前工作环境切换到 node v10
 
 然后你就可以在本地环境运行和建立网站了。
 

diff --git a/community/zh-cn/release.md b/community/zh-cn/release.md
@@ -556,8 +556,8 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/dolphinscheduler/${RELEA
 3. 更新下载页面
 
 ```
-https://dolphinscheduler.apache.org/en-us/docs/user_doc/download.html
-https://dolphinscheduler.apache.org/zh-cn/docs/user_doc/download.html
+https://dolphinscheduler.apache.org/en-us/download/download.html
+https://dolphinscheduler.apache.org/zh-cn/download/download.html
 ```
 
 4. 发送邮件到`general@incubator.apache.org`和`dev@dolphinscheduler.apache.org`通知完成版本发布。
@@ -581,7 +581,7 @@ Dolphin Scheduler is a distributed and easy-to-expand visual DAG workflow schedu
 dedicated to solving the complex dependencies in data processing, making the scheduling system out of the box for data processing.
 
 
-Download Links: http://dolphinscheduler.apache.org/en-us/docs/user_doc/download.html
+Download Links: https://dolphinscheduler.apache.org/en-us/download/download.html
 
 Release Notes: https://github.com/apache/incubator-dolphinscheduler/blob/${RELEASE.VERSION}/ReleaseNotes.md
 

diff --git a/development/en-us/architecture-design.md b/development/en-us/architecture-design.md
@@ -98,7 +98,7 @@ Before explaining the architecture of the schedule system, let us first understa
 
      - **UI**
 
-       The front-end page of the system provides various visual operation interfaces of the system. For details, see the <a href="/en-us/docs/user_doc/system-manual.html" target="_self">System User Manual</a> section.
+       The front-end page of the system provides various visual operation interfaces of the system. For details, see the <a href="/en-us/docs/latest/user_doc/system-manual.html" target="_self">System User Manual</a> section.
 
 
 

diff --git a/development/en-us/download.md b/development/en-us/download.md
diff --git a/development/zh-cn/architecture-design.md b/development/zh-cn/architecture-design.md
@@ -88,7 +88,7 @@
 
 * **UI** 
 
-    系统的前端页面，提供系统的各种可视化操作界面，详见<a href="/zh-cn/docs/user_doc/system-manual.html" target="_self">系统使用手册</a>部分。
+    系统的前端页面，提供系统的各种可视化操作界面，详见<a href="/zh-cn/docs/latest/user_doc/system-manual.html" target="_self">系统使用手册</a>部分。
 
 #### 2.3 架构设计思想
 

diff --git a/development/zh-cn/download.md b/development/zh-cn/download.md
diff --git a/docs/en-us/1.2.1/user_doc/architecture-design.md b/docs/en-us/1.2.1/user_doc/architecture-design.md
@@ -98,7 +98,7 @@ Before explaining the architecture of the schedule system, let us first understa
 
      - **UI**
 
-       The front-end page of the system provides various visual operation interfaces of the system. For details, see the <a href="/en-us/docs/user_doc/system-manual.html" target="_self">System User Manual</a> section.
+       The front-end page of the system provides various visual operation interfaces of the system. For details, see the <a href="/en-us/docs/1.2.1/user_doc/system-manual.html" target="_self">System User Manual</a> section.
 
 
 

diff --git a/docs/en-us/1.3.1/user_doc/architecture-design.md b/docs/en-us/1.3.1/user_doc/architecture-design.md
@@ -100,7 +100,7 @@ Before explaining the architecture of the scheduling system, let's first underst
 
 * **UI** 
 
-    The front-end page of the system provides various visual operation interfaces of the system,See more at<a href="/en-us/docs/user_doc/system-manual.html" target="_self"> System User Manual </a>section。
+    The front-end page of the system provides various visual operation interfaces of the system,See more at<a href="/en-us/docs/1.3.1/user_doc/system-manual.html" target="_self"> System User Manual </a>section。
 
 #### 2.3 Architecture design ideas
 

diff --git a/docs/en-us/1.3.3/user_doc/cluster-deployment.md b/docs/en-us/1.3.3/user_doc/cluster-deployment.md
@@ -20,9 +20,9 @@
 mkdir -p /opt/dolphinscheduler;
 cd /opt/dolphinscheduler;
 # unzip
-tar -zxvf apache-dolphinscheduler-incubating-1.3.2-dolphinscheduler-bin.tar.gz -C /opt/dolphinscheduler;
+tar -zxvf apache-dolphinscheduler-incubating-1.3.3-dolphinscheduler-bin.tar.gz -C /opt/dolphinscheduler;
 
-mv apache-dolphinscheduler-incubating-1.3.2-dolphinscheduler-bin  dolphinscheduler-bin
+mv apache-dolphinscheduler-incubating-1.3.3-dolphinscheduler-bin  dolphinscheduler-bin
 ```
 
 # 3、Create deployment user and hosts mapping

diff --git a/docs/en-us/1.3.3/user_doc/standalone-deployment.md b/docs/en-us/1.3.3/user_doc/standalone-deployment.md
@@ -21,10 +21,10 @@ mkdir -p /opt/dolphinscheduler;
 cd /opt/dolphinscheduler;
 
 # unzip
-tar -zxvf apache-dolphinscheduler-incubating-1.3.2-dolphinscheduler-bin.tar.gz -C /opt/dolphinscheduler;
+tar -zxvf apache-dolphinscheduler-incubating-1.3.3-dolphinscheduler-bin.tar.gz -C /opt/dolphinscheduler;
 
 # rename
-mv apache-dolphinscheduler-incubating-1.3.2-dolphinscheduler-bin  dolphinscheduler-bin
+mv apache-dolphinscheduler-incubating-1.3.3-dolphinscheduler-bin  dolphinscheduler-bin
 ```
 
 # 3、Create deployment user and assign directory operation permissions