Skip to content

Documentation Maintenance Overview

Jump to bottom
Katrina Prosise edited this page Mar 18, 2021 · 1 revision

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

mion-docs is licensed under CC BY-SA 4.0. for more information, see LICENSE.md

© 2021 Network Grade Linux. Copyright © 2021 Network Grade Linux The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page page. Linux is a registered trademark of Linus Torvalds. Privacy Policy and Terms of Use.

Clone this wiki locally