Google Git
Sign in
apache / dolphinscheduler-website / 8ca3548ff4cd7ae2977eabc04c9367c64c2ca009
commit8ca3548ff4cd7ae2977eabc04c9367c64c2ca009[log] [tgz]
authorJiajie Zhong <zhongjiajie955@gmail.com>Wed Aug 10 16:17:53 2022 +0800
committerGitHub <noreply@github.com>Wed Aug 10 16:17:53 2022 +0800
tree99e645378607059950f46b17c3fa32cf3dc0c2f2
parent95e4e571c6acacdde623aa09683ba5179e96ff5e [diff]
[impv] Allow change config by env variable run prepare_docs.sh (#818)

This patch allows user change the default setting from environment variable, which
make change easier
3 files changed
tree: 99e645378607059950f46b17c3fa32cf3dc0c2f2
  1. .github/
  2. asset/
  3. blog/
  4. community/
  5. download/
  6. file/
  7. img/
  8. scripts/
  9. site_config/
  10. src/
  11. utils/
  12. .asf.yaml
  13. .babelrc
  14. .dlc.json
  15. .docsite
  16. .eslintrc
  17. .gitignore
  18. .htaccess
  19. .nojekyll
  20. docsite.config.yml
  21. googled0df7b96f277a143.html
  22. gulpfile.js
  23. HOW_PREPARE_WOKR.md
  24. LICENSE
  25. package.json
  26. README.md
  27. redirect.ejs
  28. sitemap.xml
  29. template.ejs
  30. webpack.config.js
README.md

Apache DolphinScheduler Official Website

This project keeps all sources used for building up DolphinScheduler's official website which is served at https://dolphinscheduler.apache.org/.

Prerequisite

DolphinScheduler website is powered by docsite. Please also make sure your node version is 10+, version lower than 10.x is not supported yet.

Build Website Locally

  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
  3. Run npm run start in the root directory to start a local server, you will see the website in ‘http://localhost:8080’.
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'".
When meeting this problem. You can run two steps in the cmd.exe as an ADMINISTRATOR MEMBER.
  1. Run npm run build to build source code into dist directory.
  2. Verify your change locally: python -m SimpleHTTPServer 8000, when your python version is 3 use :python3 -m http.server 8000 instead.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install nvm
  2. Run nvm install v10.23.1 to install node v10
  3. Run nvm use v10.23.1 to switch the working environment to node v10

Then you are all set to run and build the website. Follow the build instruction above for the details.

How to send a PR

  1. Do not use git add . to commit all the changes.
  2. Just push your changed files, such as:
    • *.md
    • blog.js or docs.js or site.js
  3. Send a PR to master branch.

SEO

Make sure each .md starts with the following texts:

---
title: title
keywords: keywords1,keywords2, keywords3
description: some description
---

Guide for adding a new document

Add a new blog

  1. Add new .md file under blog/en-us or blog/zh-cn.
  2. Update site_config/blog.js, add a new entry to the blog in either en-us or zh-cn.
  3. Run docsite start locally to verify the blog can be displayed correctly.
  4. Send the pull request contains the .md and blog.js only.

Best Regards.
Thanks for reading :)