Automated deployment: Wed Jun 10 15:30:56 UTC 2020 b734f827beedbec81e646995358343b42c17ea23
4 files changed
tree: e3eb8fa5c7295d5d4b9d6bd180bc4be94c246edf
  1. .babelrc
  2. .docsite
  3. .eslintrc
  4. .gitignore
  5. .htaccess
  6. 404.html
  7. COMMIT_ID
  8. LICENSE
  9. PULL_REQUEST_TEMPLATE.md
  10. README.md
  11. baidu_verify_9ea1htgFIo.html
  12. blog/
  13. build/
  14. docs/
  15. en-us/
  16. google7362984ffdc17d37.html
  17. gulpfile.js
  18. img/
  19. index.html
  20. md_json/
  21. package.json
  22. redirect.ejs
  23. schema/
  24. site_config/
  25. sitemap.xml
  26. src/
  27. template.ejs
  28. utils/
  29. webpack.config.js
  30. zh-cn/
README.md

Dubbo Official WebSite

This project keeps all sources used for building up dubbo official website which's served at http://dubbo.io or http://dubbo.apache.org.

Prerequisite

Dubbo website is powered by docsite. If your version of docsite is less than 1.3.3, please upgrade to 1.3.3. Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.

Build instruction

  1. Run npm install docsite -g to install the dev tool.
  2. Run npm i in the root directory to install the dependencies.
  3. Run docsite start in the root directory to start a local server, you will see the website in ‘http://127.0.0.1:8080’.
  4. Run docsite build to build source code.
  5. 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 v8.16.0 to install node v8
  3. Run nvm use v8.16.0 to switch the working environment to node v8
  4. Run npm install docsite -g

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 asf-site branch.

SEO

Make sure each .md starts with the following texts:

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

Refer to this blog

Guide for adding 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.

Add a new article for developers

  1. Add new .md file under docs/en-us/developers or docs/zh-cn/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
  2. Update site_config/develop.js, add a new entry in either en-us or zh-cn.
  3. Run docsite start locally to verify the article can be displayed correctly.
  4. Send the pull request contains the *_dev.md and develop.js only.