This is an automated email from the ASF dual-hosted git repository.
zihaoxiang 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 6d8f3cfa74 [Doc] Modified README based on Copilot's comments (#981)
6d8f3cfa74 is described below
commit 6d8f3cfa742ced16b99858b48c7c797f488dffac
Author: Applenice <[email protected]>
AuthorDate: Tue May 13 12:45:04 2025 +0800
[Doc] Modified README based on Copilot's comments (#981)
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 0628f256ec..69f3205742 100644
--- a/README.md
+++ b/README.md
@@ -8,15 +8,15 @@ This project keeps all sources used for building up
DolphinScheduler's official
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](HOW_PREPARE_WORK.md)
-3. Run `yarn generate` in the root directory to format and perpare the data.
+3. Run `yarn generate` in the root directory to format and prepare the data.
4. Run `yarn dev` in the root directory to start a local server, you will see
the website in 'http://localhost:3000'.
```
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.
+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.
+When you encounter this problem. You can run the two steps in cmd.exe as an
administrator on your Windows system.
```
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.
