flux2 icon indicating copy to clipboard operation
flux2 copied to clipboard

Published 20 hours ago • verified publisher icon fluxcd

Automate documenting controller flags at fluxcd.io/docs

Open makkes opened this issue 2 years ago • 5 comments

Currently, we do not document any of our controllers' flags at https://fluxcd.io/docs so users typically have to find out the available flags themselves, e.g. by running docker run -it --rm ghcr.io/fluxcd/source-controller:v0.22.5 -h.

The flags should be documented on a separate page under https://fluxcd.io/docs/components/<component>/.

A good example of CLI flag documentation is https://kubernetes.io/docs/reference/command-line-tools-reference/.

The documentation should be generated automatically with each new controller release.

makkes avatar Apr 20 '22 10:04 makkes

i can take a stab at this!

takirala avatar May 24 '22 16:05 takirala

Reopening to take automation of this task into account.

makkes avatar Jun 07 '22 15:06 makkes

@takirala have you already started working on this?

makkes avatar Jun 07 '22 16:06 makkes

Sorry I haven't had a chance to start wlth this. (feel free to pick this up, I probably won't be able to get to this for another week atleast).

takirala avatar Jun 07 '22 16:06 takirala

No worries and thanks for coming back to this. I unassigned you for now but please don't hesitate to pick it back up if you're still up for the task.

makkes avatar Jun 08 '22 10:06 makkes