pinxiong / dubbo-website

Apache Dubbo documents

Dubbo Official Website

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

Overview

The Apache Dubbo docs are built using Hugo with the Docsy theme. This project contains the hugo project, markdown files, and theme configurations.

Pre-requisites

• Hugo extended version
• Node.js

Environment setup

1. Ensure pre-requisites are installed
2. Clone this repository

git clone https://github.com/apache/dubbo-website.git

3. Change to root directory:

cd dubbo-website

4. Add Docsy submodule:

git submodule add https://github.com/google/docsy.git themes/docsy

5. Update submodules:

git submodule update --init --recursive

6. Install npm packages:

npm install

Run local server

1. Run

hugo server --disableFastRender

2. Navigate to http://localhost:1313

Update docs

1. Create new branch
2. Commit and push changes to content
3. Submit pull request to master branch
4. Staging site will automatically get created and linked to PR to review and test