Documentation Maintenance Overview

This information pertains to the management and configuration of the main documentation, <docs.mion.io>. For contributing to our documentation, see CONTRIBUTING.md

As such, the following is of interest only for maintainers of mion-docs or project leads/managers.

Updating the static site

The published site is connected to the gh-pages branch. This branch should not be updated/pulled into directly; it contains the html that is generated by MkDocs.

See Contributing:Making Changes for general setup. In addition, you will want to install mike. To test changes that will be merged to gh-pages, run mike deploy <release_name or alias> and navigate to the test server page. To actually deploy, add --remote