Update go doc (#2952)

31 files changed
tree: 46f80cebd5651f5641ad276018115076400c74da
  1. .github/
  2. archetypes/
  3. assets/
  4. content/
  5. data/
  6. i18n/
  7. layouts/
  8. static/
  9. .asf.yaml
  10. .gitignore
  11. .gitmodules
  12. .gitpod.yml
  13. .htaccess
  14. .htmltest.yml
  15. 404.html
  16. baidu_verify_9ea1htgFIo.html
  17. cn_config.toml
  18. config.toml
  19. go.mod
  20. go.sum
  21. LICENSE
  22. netlify.toml
  23. package.json
  24. README.md
README.md

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 markdown source files of the Dubbo documentation.

Pre-requisites

Environment setup

You can directly start working on this repository even from your browser by just clicking on the following button

Open in Gitpod

Or, you can follow the manual steps given below.

  1. Ensure pre-requisites are installed
  2. Clone this repository
git clone https://github.com/apache/dubbo-website.git
  1. Install PostCSS required by Docsy by running the following commands from the root directory of your project:
$ npm install --save-dev autoprefixer
$ npm install -D postcss
$ npm install --save-dev postcss-cli

Run server locally

  1. Clear up your local module cache
hugo mod clean
  1. Start the server
hugo server --disableFastRender
# If you get stuck with 'hugo: downloading modules …' after running this command, please try to set GOPROXY by running `export GOPROXY="https://goproxy.cn|https://proxy.golang.com.cn"` and try again.
  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