fijimunkii / ubuntu-cloud-docs

Public Docs for Ubuntu in the Clouds

Ubuntu cloud documentation

Documentation for Ubuntu on public clouds. This documentation is composed of seven related documentation sets. The first one is for content related to public clouds in general and includes links to the remaining six. Five of the remaining six pertain to different cloud partners (AWS, Azure, IBM, Google cloud and Oracle cloud), while the last one is for container (OCI) registries.

Each documentation set is currently published to a different location:

• https://canonical-public-cloud.readthedocs-hosted.com/
• https://canonical-aws.readthedocs-hosted.com/
• https://canonical-azure.readthedocs-hosted.com/
• https://canonical-gcp.readthedocs-hosted.com/
• https://canonical-ibm.readthedocs-hosted.com/
• https://canonical-oci.readthedocs-hosted.com/
• https://canonical-oracle.readthedocs-hosted.com/

How to work with this documentation

Download and install

Fork and clone this repository.

Once cloned, run:

make install

This invokes the install command in the Makefile, and creates a virtual environment (.sphinx/venv) and installs dependencies in .sphinx/requirements.txt.

A complete set of pinned, known-working dependencies is included in .sphinx/pinned-requirements.txt.

Build and serve the documentation

The make run command can be used to start the sphinx-autobuild documentation server. Since each cloud has it's own separate documentation set, you have to specify the required cloud name as a command line parameter. For example the command below will build and serve the documentation for AWS cloud:

PROJECT=aws make run

The different projects that can be specfied are 'all-clouds', 'aws', 'azure', 'google', 'ibm', 'oracle' and 'oci'.

The documentation will be available at 127.0.0.1:8000 or equivalently at localhost:8000.

The command:

• activates the virtual environment and serves the documentation
• rebuilds the documentation each time you save a file
• sends a reload page signal to the browser when the documentation is rebuilt

(This is the most convenient way to work on the documentation, but you can still use the more standard make html. For instance, PROJECT=azure make html will create the azure related html pages in _build/azure.)

Check spelling

Run a spell check:

PROJECT=azure make spelling

If new words are to be added to the allowed list, update .custom_wordlist.txt accordingly.

Check links

Run a check for broken links:

PROJECT=google make linkcheck

Per project contribution guidelines

Each project has its own contribution guide: * All-clouds * AWS * Azure * Google * IBM * OCI container registries * Oracle