Skip to content
Apache Dubbo documents
Branch: master
Clone or download
lixiaojiee and htynkn Fix registry protocol description (#407)
* Close #353
* add sofa and consul registry
Latest commit d5b2314 Jun 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
blog modify 2.7.2-release Jun 6, 2019
docs Fix registry protocol description (#407) Jun 21, 2019
img
schema/dubbo
site_config fix Eco System some item url (#413) Jun 21, 2019
src remove incubator (#377) May 25, 2019
utils new version, please read README.md first (#88) Aug 13, 2018
.babelrc Dubbo new website Jul 3, 2018
.docsite Dubbo new website Jul 3, 2018
.eslintrc Dubbo new website Jul 3, 2018
.gitignore remove md_json folder Jun 14, 2019
404.html build site Oct 10, 2018
LICENSE initial cut for new github pages Sep 11, 2017
PULL_REQUEST_TEMPLATE.md remove incubator (#377) May 25, 2019
README.md fix typos and make some changes on readme (#404) Jun 16, 2019
baidu_verify_9ea1htgFIo.html add baidu site verification file Sep 6, 2018
google7362984ffdc17d37.html update sitemap, and use html-upload to validate Aug 13, 2018
gulpfile.js feat: 品牌色,添加字体,Safari跨域拦截导致star fork数获取失败等问题 (#348) Apr 3, 2019
package.json Avoid global install for docsite (#378) Jun 12, 2019
redirect.ejs build site Oct 10, 2018
sitemap.xml update sitemap, and use html-upload to validate Aug 13, 2018
template.ejs rebuild, move google analysis code from header to body Aug 13, 2018
webpack.config.js feat: 品牌色,添加字体,Safari跨域拦截导致star fork数获取失败等问题 (#348) Apr 3, 2019

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 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.
You can’t perform that action at this time.