Docs from the ground up
Our docs are just Markdown, but offer you more flexibility and styling options.
You are viewing documentation for Flux version: 2.0
Version 2.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
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.
To better understand the mechanics of adding blog posts, please see https://github.com/fluxcd/website/tree/main/internal_docs/how-to-write-a-blog-post.md.
In this section we will focus on common use-cases of folks who contribute to docs.
Proposing changes
How to propose pull requests using either the GitHub UI or git locally.
Documentation Style Guide
Style Guide for Flux Documentation
Last modified 2023-03-29: create internal docs directory (0db988f)