Dubbo-go Official Website

This project includes official documents and blogs of Dubbo-go to guide users to use Dubbo go correctly.

Prerequisite

Dubbo-go website is powered by docsite.

please use docsite version at 1.3.9.

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@1.3.9 -g to install the dev tool.
2. Run npm i in the root directory to install the dependencies.
3. Run docsite build to build source code.
4. 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@1.3.9 -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
---

Guide for adding new document

Add a new doc

1. Add new .md file under docs/en-us or docs/zh-cn.
2. Update site_config/docs.js, add a new entry to the docs 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 docs.js only.

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.