Good documentation is critical for any type of software. Any contribution that can improve the DolphinScheduler documentation is welcome.
Documentation for the DolphinScheduler project is maintained in a separate git repository.
First you need to fork the document project into your own github repository, and then clone the document to your local computer.
git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
The DolphinScheduler website is supported by docsite
Make sure that your node version is 10+, docsite does not yet support versions higher than 10.x.
npm install in the root directory to install the dependencies.
npm run start in the root directory to start a local server, you will see the website in 'http://localhost:8080'.
npm run build to build source code into dist directory.
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.
Refer to the Instructions to install nvm.
nvm install v10.23.1 to install node v10.
nvm use v10.23.1 to switch the current working environment to node v10.
Now you can run and build the website in your local environment.
** Spaces are Required ** between Chinese characters and English or numbers and ** Spaces are not required ** between Chinese punctuation marks and English or numbers, to enhance the aesthetics and readability of the Chinese-English mix.
It is recommended that you use "you" in general. Of course, you can use the term when necessary, such as when there is a warning prompt.
Do not use "git add." to commit all changes.
Simply push the changed files, for example:
blog.js or docs.js or site.js