English | 简体中文

This repository contains Cloudpods related documentation.

The documentation is compiled and developed using docker running hugo container, which has the advantage of not requiring local installation and configuration of hugo to ensure a uniform development environment.

• hugo v0.83.0:
  • Linux: https://github.com/gohugoio/hugo/releases/download/v0.83.1/hugo_extended_0.83.1_Linux-64bit.tar.gz
  • MacOS:
    • x86_64: https://github.com/gohugoio/hugo/releases/download/v0.83.1/hugo_extended_0.83.1_macOS-64bit.tar.gz
    • arm64: https://github.com/gohugoio/hugo/releases/download/v0.83.1/hugo_extended_0.83.1_macOS-ARM64.tar.gz
• docker: To install docker, please refer to the documentation at https://docs.docker.com/get-docker/.

$ git clone https://github.com/yunionio/docs --recursive
$ cd docs

# npm install dependencies
$ npm install -i

# view CE(community edition) docs
$ make ce-local-serve

# view EE(enterprise edition) docs
$ make ee-local-serve

# Then visit http://localhost:1313 to view the documentation site

The documents are in the content/{en,zh} directory, select the desired section to edit or add, for content organization please refer to: https://gohugo.io/content-management/organization/.

There are no multiple versions of the documentation in the development phase. To see the effect of multiple versions of the documentation, you can run the following command.

# Compiling multiple versions of documentation using docker.
# Then the documentation site will be in the . /public directory.
$ make ce-build
$ cd public && python3 -m http.server 1313

$ git submodule update --recursive
$ git pull --recurse-submodules

$ REGISTRY=registry.cn-beijing.aliyuncs.com/yunionio TAG=your-tag ARCH=all make ee-image