grafana
Documentation about CR
Feature Description
Provide a exhaustive list of options related to create a CR definition
Suggested Solution (optional)
No response
Already existing or connected issues / PRs (optional)
No response
Thanks for opening this @DanielCastronovo! This was definitely discussed before internally so it is in the plans as part of improvement of k6-operator docs :+1:
Ideally, I'd prefer to have an automated task generating some kind of table of options, in Markdown, etc., which we could then include into other docs.
Btw, apparently quiet option is not easy to find: https://github.com/grafana/k6-operator/issues/331#issuecomment-1880807398
Some options for docs generation to consider:
- https://github.com/srfrnk/crd-api-doc-gen
- https://github.com/CloudTooling/crd-api-doc-generator
Another question came up about CRD option paused:
https://community.grafana.com/t/v0-0-14-testrun-property-spec-paused-not-behaving-as-expected/124255/3
This question adds a requirement about defaults: in generated documentation, we should have default values specified so the automation must be able to extract the default values correctly as well. E.g. in Go, default value for string is "" but for paused it's actually "true".