Skip to content

Commit 3275a76

Browse files
authored
[Chore][docs] Update documentation notice content sync with website readme (#17160)
1 parent 43a27e1 commit 3275a76

2 files changed

Lines changed: 36 additions & 32 deletions

File tree

docs/docs/en/contribute/join/document.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,33 @@ First you need to fork the document project into your own github repository, and
1212
git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
1313
```
1414

15-
### The document environment
16-
17-
The DolphinScheduler website is supported by [docsite](https://github.com/chengshiwen/docsite-ext)
18-
19-
Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x.
20-
2115
### Document build guide
2216

23-
1. Run `npm install` in the root directory to install the dependencies.
24-
25-
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_WORK.md).
26-
27-
3. Run `npm run start` in the root directory to start a local server, you will see the website in 'http://localhost:8080'.
17+
1. Run `yarn` in the root directory to install the dependencies.
18+
2. Run commands to collect resources
19+
2.1. Run `export PROTOCOL_MODE=ssh` tells Git clone resource via SSH protocol instead of HTTPS protocol
20+
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_WORK.md)
21+
3. Run `yarn generate` in the root directory to format and prepare the data.
22+
4. Run `yarn dev` in the root directory to start a local server, you will see the website in 'http://localhost:3000'.
2823

29-
4. Run `npm run build` to build source code into dist directory.
30-
31-
5. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your python version is 3 use :`python3 -m http.server 8000` instead.
32-
33-
If the latest version of node is installed locally, consider using `nvm` to allow different versions of `node` to run on your computer.
24+
```
25+
Note: if you clone the code in Windows, not Mac or Linux. Please read the details below.
26+
If you execute the commands like the two steps above, you will get the exception "UnhandledPromiseRejectionWarning: Error: EPERM: operation not permitted, symlink '2.0.3' -> 'latest'".
27+
If you get the exception "Can't resolve 'antd' in xxx",you can run `yarn add antd` and `yarn install`.
28+
Because the `./scripts/prepare_docs.sh` command requires a Linux environment, if you are on a Windows system, you can use WSL to complete this step.
29+
When you encounter this problem. You can run the two steps in cmd.exe as an administrator on your Windows system.
30+
```
3431

35-
1. Refer to the [Instructions](http://nvm.sh) to install nvm.
32+
5. Run `yarn build` to build source code, this will automatically generate a directory called `build`, wait for the execution to complete and into `build` directory.
33+
6. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your python version is 3 use :`python3 -m http.server 8000` instead.
3634

37-
2. Run `nvm install v10.23.1` to install node v10.
35+
If you have higher version of node installed, you may consider `nvm` to allow different versions of `node` coexisting on your machine.
3836

39-
3. Run `nvm use v10.23.1` to switch the current working environment to node v10.
37+
1. Follow the [instructions](http://nvm.sh) to install nvm
38+
2. Run `nvm install v18.12.1` to install node v18
39+
3. Run `nvm use v18.12.1` to switch the working environment to node v18
4040

41-
Now you can run and build the website in your local environment.
41+
Then you are all set to run and build the website. Follow the build instruction above for the details.
4242

4343
### The document specification
4444

docs/docs/zh/contribute/join/document.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,35 @@ DolphinScheduler 项目的文档维护在独立的 [git 仓库](https://github.c
1212
git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
1313
```
1414

15-
### 文档环境
16-
17-
DolphinScheduler 网站由 [docsite](https://github.com/chengshiwen/docsite-ext) 提供支持。
18-
19-
请确保你的 node 版本是 10+,docsite 尚不支持高于 10.x 的版本。
20-
2115
### 文档构建指南
2216

23-
1. 在根目录中运行 `npm install` 以安装依赖项。
17+
1. 在根目录中运行 `yarn` 以安装依赖项。
2418

2519
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_WORK.md)
2620

27-
3. 在根目录下运行 `npm run start` 启动本地服务器,其将允许在 http://localhost:8080。
21+
3. 在根目录下运行 `yarn generate` 来格式化和准备数据。
22+
23+
4. 在根目录下运行 `yarn dev` 启动本地服务器,其将允许在 http://localhost:3000。
24+
25+
```
26+
注意:如果您在 Windows 而非 Mac 或 Linux 中克隆代码。请阅读下面的详细信息。
27+
如果执行上述两个步骤中的命令,将出现异常 “UnhandledPromiseRejectionWarning.Error:”: Error: EPERM: operation not permitted, symlink ‘2.0.3’ -> ‘latest’".
28+
如果出现异常 “Can't resolve ‘antd’ in xxx”,你可以运行 `yarn add antd` 和 `yarn install`。
29+
因为这两个步骤运行的命令`./scripts/prepare_docs.sh`应该是 Linux 环境,所以如果你是 Windows 系统,可以使用 WSL 来完成。
30+
遇到这个问题时。你可以以管理员身份运行 cmd.exe 中的两个步骤。
31+
```
2832

29-
4. 运行 `npm run build` 可以生成文档网站源代码
33+
5. 运行 `yarn build` 来构建源代码,此时会自动生成一个名为 `build` 目录,等待执行完成之后进入 `build` 目录
3034

31-
5. 在本地验证你的更改:`python -m SimpleHTTPServer 8000`,当 python 版本为 3 时,请使用:`python3 -m http.server 8000`
35+
6. 在本地验证你的更改:`python -m SimpleHTTPServer 8000`,当 python 版本为 3 时,请使用:`python3 -m http.server 8000`
3236

3337
如果本地安装了更高版本的 node,可以考虑使用 `nvm` 来允许不同版本的 `node` 在你的计算机上运行。
3438

3539
1. 参考[说明](http://nvm.sh)安装 nvm
3640

37-
2. 运行 `nvm install v10.23.1` 安装 node v10
41+
2. 运行 `nvm install v18.12.1` 安装 node v18
3842

39-
3. 运行 `nvm use v10.23.1` 将当前工作环境切换到 node v10
43+
3. 运行 `nvm use v18.12.1` 将当前工作环境切换到 node v18
4044

4145
然后你就可以在本地环境运行和建立网站了。
4246

0 commit comments

Comments
 (0)