Apache Dubbo documents

Clone this repo:
  1. f48eac9 Merge branch 'master' of https://github.com/apache/dubbo-website by ken.lj · 7 hours ago master
  2. 2efe9a5 add security mail by ken.lj · 7 hours ago
  3. 10275e5 Update best-practice.md (#709) by zenuo · 18 hours ago
  4. 59df7f3 update security page content by ken.lj · 3 days ago
  5. 99ad9aa add deserialization notices by ken.lj · 3 days ago

Dubbo Official Website

CI Status

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

Environment setup

  1. Ensure pre-requisites are installed
  2. Clone this repository
git clone https://github.com/apache/dubbo-website.git
  1. Change to root directory:
cd dubbo-website
  1. Add Docsy submodule:
git submodule add https://github.com/google/docsy.git themes/docsy
  1. Update submodules:
git submodule update --init --recursive
  1. Install npm packages:
npm install

Run local server

  1. Run
hugo server --disableFastRender
  1. 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