This is an automated email from the ASF dual-hosted git repository.
chengshiwen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 632e6c191 Update the documentation instructions for starting the
documentation (#813)
632e6c191 is described below
commit 632e6c191ef7c2d05e2ad0b9530a061128ef28af
Author: zhangyingjie <[email protected]>
AuthorDate: Tue Jul 19 20:02:30 2022 +0800
Update the documentation instructions for starting the documentation (#813)
* [doc]: add the steps of using the document instructions
* [doc]: modify the format
* [doc]:add links and backticks
* [doc]:add links and backticks
Co-authored-by: zhangyingjie <[email protected]>
---
community/en-us/development/document.md | 8 +++++---
community/zh-cn/development/document.md | 8 +++++---
2 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/community/en-us/development/document.md
b/community/en-us/development/document.md
index e1e76ab41..f2fd83140 100644
--- a/community/en-us/development/document.md
+++ b/community/en-us/development/document.md
@@ -22,11 +22,13 @@ Make sure that your node version is 10+, docsite does not
yet support versions h
1. Run `npm install` 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://localhost:8080'.
+2. Run commands to collect resources 2.1.Run `export PROTOCOL_MODE=ssh` tells
Git clone resource via SSH protocol instead of HTTPS protocol. 2.2.Run
`./scripts/prepare_docs.sh` prepare all related resources, for more information
you could see [how prepare script
work](https://github.com/apache/dolphinscheduler-website/blob/master/HOW_PREPARE_WOKR.md).
-3. Run `npm run build` to build source code into dist directory.
+3. Run `npm run start` in the root directory to start a local server, you will
see the website in 'http://localhost:8080'.
-4. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your
python version is 3 use :`python3 -m http.server 8000` instead.
+4. Run `npm run build` to build source code into dist directory.
+
+5. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your
python version is 3 use :`python3 -m http.server 8000` instead.
If the latest version of node is installed locally, consider using `nvm` to
allow different versions of `node` to run on your computer.
diff --git a/community/zh-cn/development/document.md
b/community/zh-cn/development/document.md
index 78d825eb6..6d9fde3e2 100644
--- a/community/zh-cn/development/document.md
+++ b/community/zh-cn/development/document.md
@@ -22,11 +22,13 @@ DolphinScheduler 网站由
[docsite](https://github.com/chengshiwen/docsite-ext)
1. 在根目录中运行 `npm install` 以安装依赖项。
-2. 在根目录下运行 `npm run start` 启动本地服务器，其将允许在 http://localhost:8080。
+2. 运行命令收集资源：2.1.运行 `export PROTOCOL_MODE=ssh` 告诉Git克隆资源，通过SSH协议而不是HTTPS协议。
2.2.运行 `./scripts/prepare_docs.sh` 准备所有相关资源，关更多信息，您可以查看[how prepare script
work](https://github.com/apache/dolphinscheduler-website/blob/master/HOW_PREPARE_WOKR.md)。
-3. 运行 `npm run build` 可以生成文档网站源代码。
+3. 在根目录下运行 `npm run start` 启动本地服务器，其将允许在 http://localhost:8080。
-4. 在本地验证你的更改：`python -m SimpleHTTPServer 8000`，当 python 版本为 3 时，请使用：`python3
-m http.server 8000`。
+4. 运行 `npm run build` 可以生成文档网站源代码。
+
+5. 在本地验证你的更改：`python -m SimpleHTTPServer 8000`，当 python 版本为 3 时，请使用：`python3
-m http.server 8000`。
如果本地安装了更高版本的 node，可以考虑使用 `nvm` 来允许不同版本的 `node` 在你的计算机上运行。
