Copilot commented on code in PR #17160: URL: https://github.com/apache/dolphinscheduler/pull/17160#discussion_r2081314320
########## docs/docs/en/contribute/join/document.md: ########## @@ -12,33 +12,33 @@ First you need to fork the document project into your own github repository, and git clone https://github.com/<your-github-user-name>/dolphinscheduler-website ``` -### The document environment - -The DolphinScheduler website is supported by [docsite](https://github.com/chengshiwen/docsite-ext) - -Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x. - ### Document build guide -1. Run `npm install` in the root directory to install the dependencies. - -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). - -3. Run `npm run start` in the root directory to start a local server, you will see the website in 'http://localhost:8080'. +1. Run `yarn` in the root directory to install the dependencies. +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) +3. Run `yarn generate` in the root directory to format and perpare the data. Review Comment: The word "perpare" appears to be a typo; please change it to "prepare". ```suggestion 3. Run `yarn generate` in the root directory to format and prepare the data. ``` ########## docs/docs/en/contribute/join/document.md: ########## @@ -12,33 +12,33 @@ First you need to fork the document project into your own github repository, and git clone https://github.com/<your-github-user-name>/dolphinscheduler-website ``` -### The document environment - -The DolphinScheduler website is supported by [docsite](https://github.com/chengshiwen/docsite-ext) - -Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x. - ### Document build guide -1. Run `npm install` in the root directory to install the dependencies. - -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). - -3. Run `npm run start` in the root directory to start a local server, you will see the website in 'http://localhost:8080'. +1. Run `yarn` in the root directory to install the dependencies. +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) +3. Run `yarn generate` in the root directory to format and perpare the data. +4. Run `yarn dev` in the root directory to start a local server, you will see the website in 'http://localhost:3000'. -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. +``` +Note: if you clone the code in Windows, not Mac or Linux. Please read the details below. +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'". +If you get the exception "Can't resolve 'antd' in xxx",you can run `yarn add antd` and `yarn install`. +Because the two steps run command `./scripts/prepare_docs.sh` should Linux environment,so if you are a windwos system you can use WSL do it. Review Comment: Please correct "windwos" to "Windows" and consider revising the sentence for clarity, for example: "... so if you are on a Windows system, you can use WSL to complete this step." ```suggestion 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. ``` ########## docs/docs/en/contribute/join/document.md: ########## @@ -12,33 +12,33 @@ First you need to fork the document project into your own github repository, and git clone https://github.com/<your-github-user-name>/dolphinscheduler-website ``` -### The document environment - -The DolphinScheduler website is supported by [docsite](https://github.com/chengshiwen/docsite-ext) - -Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x. - ### Document build guide -1. Run `npm install` in the root directory to install the dependencies. - -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). - -3. Run `npm run start` in the root directory to start a local server, you will see the website in 'http://localhost:8080'. +1. Run `yarn` in the root directory to install the dependencies. +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) +3. Run `yarn generate` in the root directory to format and perpare the data. +4. Run `yarn dev` in the root directory to start a local server, you will see the website in 'http://localhost:3000'. -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. +``` +Note: if you clone the code in Windows, not Mac or Linux. Please read the details below. +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'". +If you get the exception "Can't resolve 'antd' in xxx",you can run `yarn add antd` and `yarn install`. +Because the two steps run command `./scripts/prepare_docs.sh` should Linux environment,so if you are a windwos system you can use WSL do it. +When meeting this problem. You can run two steps in the cmd.exe as an ADMINISTRATOR MEMBER. Review Comment: [nitpick] Consider rephrasing "ADMINISTRATOR MEMBER" to "with administrative privileges" or "using an elevated command prompt" for clarity. ```suggestion When meeting this problem. You can run two steps in the cmd.exe using an elevated command prompt. ``` ########## docs/docs/zh/contribute/join/document.md: ########## @@ -12,31 +12,35 @@ DolphinScheduler 项目的文档维护在独立的 [git 仓库](https://github.c git clone https://github.com/<your-github-user-name>/dolphinscheduler-website ``` -### 文档环境 - -DolphinScheduler 网站由 [docsite](https://github.com/chengshiwen/docsite-ext) 提供支持。 - -请确保你的 node 版本是 10+，docsite 尚不支持高于 10.x 的版本。 - ### 文档构建指南 -1. 在根目录中运行 `npm install` 以安装依赖项。 +1. 在根目录中运行 `yarn` 以安装依赖项。 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)。 -3. 在根目录下运行 `npm run start` 启动本地服务器，其将允许在 http://localhost:8080。 +3. 在根目录下运行 `yarn generate` 来格式化和准备数据。 + +4. 在根目录下运行 `yarn dev` 启动本地服务器，其将允许在 http://localhost:3000。 + +``` +注意：如果您在 Windows 而非 Mac 或 Linux 中克隆代码。请阅读下面的详细信息。 +如果执行上述两个步骤中的命令，将出现异常 “UnhandledPromiseRejectionWarning.Error:”： Error： EPERM: operation not permitted, symlink ‘2.0.3’ -> ‘latest’". +如果出现异常 “Can't resolve ‘antd’ in xxx”，你可以运行 `yarn add antd` 和 `yarn install`。 +因为这两个步骤运行的命令`./scripts/prepare_docs.sh`应该是 Linux 环境，所以如果你是 windwos 系统，可以使用 WSL 来完成。 Review Comment: The text "windwos 系统" appears later in the note; please correct "windwos" to "Windows" for consistency. ```suggestion 因为这两个步骤运行的命令`./scripts/prepare_docs.sh`应该是 Linux 环境，所以如果你是 Windows 系统，可以使用 WSL 来完成。 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
