Cloudpods Documentation

This repository contains Cloudpods related documentation.

Installing Dependencies

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.

docker: To install docker, please refer to the documentation at https://docs.docker.com/get-docker/.

View Document Website

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

# Running the hugo serve container with docker
$ make container-serve
# Then visit http://localhost:1313 to view the documentation site

Edit Document

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/.

Compile Documentation

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 container-build
$ cd public && python3 -m http.server 1313

Update Submodule

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

View lastest verion of documentation

# compile the documentation of latest version
make test
# open browse to visit http://localhost:1313