CloudLabs Documentation

Material for MkDocs is used to document the important details of the CloudLabs project, including API and other technical specifications. For full documentation visit mkdocs.org.

Setup

Install the latest version of Python, in which the Python version manager, pyenv may be used:

# Install the latest version of Python 3.11
pyenv install 3.11

Git clone the repository and initialize a Python virtual environment within the directory:

# Clone the repository via SSH
git clone git@github.com:projectcatena/cloudlabs-mkdocs.git

# Init a Python virtual environment
python -m venv env

# Activate the Python venv
source env/bin/activate

Install the mkdocs-material python package:

pip install mkdocs-material

The project may be deployed locally by running the following commands:

# Start the live-reloading docs server
mkdocs serve

How to Contribute

1. Clone the repository.

git clone -b staging git@link_of_repo

2. Create and switch to a new branch

git switch -c your-new-branch-name

3. Commit changes after development

git commit -m "Describe your changes"

4. Push to remote repository

git push -u origin your-branch-name

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.