fluxcd / website

The Flux website and user documentation
https://fluxcd.io
Apache License 2.0
50 stars 323 forks source link

During the build proccess run Flux to generate the snippets in our guides #527

Open alisondy opened 2 years ago

alisondy commented 2 years ago

generate output of flux commands on the fly rather than manually check in output of snippets

involves

priority long term, nice to have, QOL

alisondy commented 2 years ago

POC of this on https://github.com/alisondy/website/tree/snippet-gen

Depends on

What it does

Currently have got it working with multi line commands Need to add more logic to handle single line commands aswell

Shelving for now but if someone wants to take this on and make it more robust, feel free to.

dholbach commented 2 years ago

I'm not sure I understand the impact or advantage of this. Can you elaborate a little?

alisondy commented 2 years ago

the benefit of this is that you wouldn't have to manually go and update the snippets when flux upgrades

and that you can be certain the snippets are up to date

dholbach commented 2 years ago

Scott said he could take a look at integrating the relevant parts from #530.