README.md

Project 2A Documentation

The home of the consolidated documentation for Project 2A sponsored by Mirantis. Project 2A may be referred to as Project 0x2A in the documentation due to legacy reasons.

Project 2A Docs

This project utilises Mkdocs with the Material theme and Mermaid for diagrams. Currently the docs are published using github actions on github pages from the branch gh-pages.

Development is tracked under Project 2A on github.

The related Project 2A repositories can be found as follows:

• HMC

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    stylesheets  # CSS stylesheets to control look and feel
    assets  # Images and other served material
    ...       # Other markdown pages, images and other files.

Setting up MKdocs and dependancies

1. Setup python Virtual Environment

   python3 -m venv ./mkdocs
   source ./mkdocs/bin/activate

2. Install MkDocs

   pip install mkdocs

3. Install plugins

   pip install mkdocs-mermaid2-plugin
   pip install mkdocs-material
   pip install markdown-callouts

Run MKdocs for dev

• Start the live-reloading docs server.

  mkdocs serve

For full documentation visit mkdocs.org.

MKdocs Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Documentation Standards

By default, we follow the Kubernetes documentation style guide.

Header Capitalization

All header text should be capitalized.

Referencing Kubernetes nested resources

Please use the dot notation. So in the following:

apiVersion: v1
kind: Secret
metadata:
  name: my-secret

To refer to the name field, please use .metadata.name and not name.