Documentation

Flux welcomes improvements from all contributors, new and experienced!

The flux website uses Hugo with the Docsy theme. Documentation is written in Markdown.

To get a good sense of the general mechanics of the repository and what your options are of running the site locally, please visit https://github.com/fluxcd/website/#readme.

In this section we will focus on common use-cases of folks who contribute to docs.


Where to find the docs and how to contribute

Where to find the documentation in the repository and how everything fits together.

Docs from the ground up

Our docs are just Markdown, but offer you more flexibility and styling options.

Proposing changes

How to propose pull requests using either the Github UI or git locally.

Documentation Style Guide

Style Guide for Flux Documentation

Custom Hugo Shortcodes