This is an automated email from the ASF dual-hosted git repository.
zihaoxiang pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new 76545e746e [Improvement-17426][docs] Complete and fix mistakes in
development md (#17427)
76545e746e is described below
commit 76545e746eab3fd2e0bc3d78309da7884ef0c6fa
Author: Calvin <[email protected]>
AuthorDate: Wed Aug 20 09:27:26 2025 +0800
[Improvement-17426][docs] Complete and fix mistakes in development md
(#17427)
---
docs/docs/en/contribute/development-environment-setup.md | 12 ++++++++++--
docs/docs/en/contribute/frontend-development.md | 6 +++---
docs/docs/zh/contribute/development-environment-setup.md | 12 ++++++++++--
docs/docs/zh/contribute/frontend-development.md | 6 +++---
4 files changed, 26 insertions(+), 10 deletions(-)
diff --git a/docs/docs/en/contribute/development-environment-setup.md
b/docs/docs/en/contribute/development-environment-setup.md
index 86fbfd653a..a988ee5244 100644
--- a/docs/docs/en/contribute/development-environment-setup.md
+++ b/docs/docs/en/contribute/development-environment-setup.md
@@ -7,8 +7,8 @@ Before setting up the DolphinScheduler development environment,
please make sure
- [Git](https://git-scm.com/downloads)
- [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html):
v1.8+
- [Maven](http://maven.apache.org/download.cgi): v3.5+
-- [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler version is
lower than 3.0, please install node v12.20+)
-- [Pnpm](https://pnpm.io/installation): v6.x
+- [Node](https://nodejs.org/en/download): v16.0+
+- [Pnpm](https://pnpm.io/installation): v8.0+ (Make sure pnpm is compatible
with Node.js, see also:
[Compatibility](https://pnpm.io/installation#compatibility))
### Clone Git Repository
@@ -155,6 +155,14 @@ Install frontend dependencies and run it.
> Note: You can see more detail about the frontend setting in [frontend
> development](./frontend-development.md).
+If you have not yet installed `pnpm`, you can install it using the following
command before running the front-end component:
+
+```shell
+npm install -g pnpm
+```
+
+After ensuring that `pnpm` has been installed, run the following command:
+
```shell
cd dolphinscheduler-ui
pnpm install
diff --git a/docs/docs/en/contribute/frontend-development.md
b/docs/docs/en/contribute/frontend-development.md
index 53fddb647c..bba03f3cd9 100644
--- a/docs/docs/en/contribute/frontend-development.md
+++ b/docs/docs/en/contribute/frontend-development.md
@@ -36,11 +36,11 @@ Use the command line mode `cd` enter the
`dolphinscheduler-ui` project director
npm config set registry http://registry.npmmirror.com/
```
-- Modify `API_BASE` in the file `dolphinscheduler-ui/.env` to interact with
the backend:
+- Modify `VITE_APP_DEV_WEB_URL` in the file
`dolphinscheduler-ui/.env.development` to interact with the backend:
```
# back end interface address
-API_BASE = http://127.0.0.1:12345
+VITE_APP_DEV_WEB_URL = 'http://127.0.0.1:12345'
```
##### ! ! ! Special attention here. If the project reports a "node-sass error"
error while pulling the dependency package, execute the following command again
after execution.
@@ -53,7 +53,7 @@ npm install node-sass --unsafe-perm #Install node-sass
dependency separately
#### Development environment operation
-- `npm start` project development environment (after startup address
http://localhost:8888)
+- `pnpm run dev` project development environment (after startup address
http://localhost:8888)
#### Front-end project release
diff --git a/docs/docs/zh/contribute/development-environment-setup.md
b/docs/docs/zh/contribute/development-environment-setup.md
index da26faf221..344795c1f5 100644
--- a/docs/docs/zh/contribute/development-environment-setup.md
+++ b/docs/docs/zh/contribute/development-environment-setup.md
@@ -7,8 +7,8 @@
* [Git](https://git-scm.com/downloads)
* [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html):
v1.8+
* [Maven](http://maven.apache.org/download.cgi): v3.5+
-* [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler 版本低于 3.0,
请安装 node v12.20+)
-* [Pnpm](https://pnpm.io/installation): v6.x
+* [Node](https://nodejs.org/en/download): v16.0+
+* [Pnpm](https://pnpm.io/installation): v8.0+
(请确保不同版本的pnpm与Node.js之间是相互兼容的，可参考：[Compatibility](https://pnpm.io/installation#compatibility))
### 克隆代码库
@@ -150,6 +150,14 @@ DolphinScheduler 开发环境配置有两个方式，分别是standalone模式
> 注意：你可以在[frontend development](./frontend-development.md)里查看更多前端的相关配置
+在运行前端组件前，如果你还没有安装`pnpm`，可以使用以下命令安装：
+
+```shell
+npm install -g pnpm
+```
+
+确保`pnpm`已经安装完成后，运行以下命令：
+
```shell
cd dolphinscheduler-ui
pnpm install
diff --git a/docs/docs/zh/contribute/frontend-development.md
b/docs/docs/zh/contribute/frontend-development.md
index 9a722056a5..d9e9a16b47 100644
--- a/docs/docs/zh/contribute/frontend-development.md
+++ b/docs/docs/zh/contribute/frontend-development.md
@@ -36,11 +36,11 @@ Node包下载 (注意版本 v12.20.2)
`https://nodejs.org/download/release/v12.2
npm config set registry http://registry.npmmirror.com/
```
-- 修改 `dolphinscheduler-ui/.env` 文件中的 `API_BASE`，用于跟后端交互：
+- 修改 `dolphinscheduler-ui/.env.development` 文件中的
`VITE_APP_DEV_WEB_URL`，用于跟后端交互：
```
# 代理的接口地址（自行修改）
-API_BASE = http://127.0.0.1:12345
+VITE_APP_DEV_WEB_URL = 'http://127.0.0.1:12345'
```
##### ！！！这里特别注意 项目如果在拉取依赖包的过程中报 " node-sass error " 错误，请在执行完后再次执行以下命令
@@ -53,7 +53,7 @@ npm install node-sass --unsafe-perm #单独安装node-sass依赖
#### 开发环境运行
-- `npm start` 项目开发环境 (启动后访问地址 http://localhost:8888)
+- `pnpm run dev` 项目开发环境 (启动后访问地址 http://localhost:8888)
#### 前端项目发布
