Google Git
Sign in
apache / dubbo-website / 62e24b4eb148cb82dbd1ad756898ea91918bea7b
commit62e24b4eb148cb82dbd1ad756898ea91918bea7b[log] [tgz]
authorXin Wang <xin.victorwang@gmail.com>Sat Aug 17 12:12:26 2019 +0800
committerGitHub <noreply@github.com>Sat Aug 17 12:12:26 2019 +0800
tree46b45f34ba8ac97fa559e5c2b62a228f72bea2b5
parente267d3dc7b67d20cb1b3e0a3f8291165e68bb4d8 [diff]
fix some issue (#449)
1 file changed
tree: 46b45f34ba8ac97fa559e5c2b62a228f72bea2b5
  1. blog/
  2. docs/
  3. img/
  4. schema/
  5. site_config/
  6. src/
  7. utils/
  8. .babelrc
  9. .docsite
  10. .eslintrc
  11. .gitignore
  12. 404.html
  13. baidu_verify_9ea1htgFIo.html
  14. google7362984ffdc17d37.html
  15. gulpfile.js
  16. LICENSE
  17. package.json
  18. PULL_REQUEST_TEMPLATE.md
  19. README.md
  20. redirect.ejs
  21. sitemap.xml
  22. template.ejs
  23. webpack.config.js
README.md

Dubbo Official Website

This project keeps all sources used for building up dubbo official website which's served at https://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 master 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.