You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
-
21
15
### Document build guide
22
16
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'.
28
23
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
+
```
34
31
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.
36
34
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.
38
36
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
40
40
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.
0 commit comments