This commit uses the `applyconfiguration-gen` tool to generate the
"apply configuration" types for all monitoring types. It enables users
to run server-side apply operations from Go code.
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* scripts:tools: Add gen-crd-api-reference-docs tool
Signed-off-by: Philip Gough <philip.p.gough@gmail.com>
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* make: Add targets and scripts to generate docs with gen-crd-api-reference-docs tool
Signed-off-by: Philip Gough <philip.p.gough@gmail.com>
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* scripts/go.mod: bump gen-crd-api-reference-docs version
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Makefile: add target to generate v1beta1 docs
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Documentation/apis: regenerate
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Makefile: remove unused variable
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* pkg/apis/monitoring: reorder markers for API docs
gen-crd-api-reference-docs requires codegen markers to appear before the
comments describing the types. Otherwise resource types aren't properly
identified.
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Documentation/apis: regenerate
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* update docs configuration
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Documentation/apis: regenerate
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Add README.md for API documentation generation
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Skip embedded fields
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Move docgen tooling to Documentation/
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* keep all APIs in a single page
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Fix header in pkg.tpl
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Update docs README.md
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Add link for apiextensions-apiserver module
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Documentation: regenerate
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Fix links in documentation
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* update pkg.tpl
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Fix check-docs CI
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Documentation/api.md: regenerate
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* scripts: bump mdox version
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
Co-authored-by: Philip Gough <philip.p.gough@gmail.com>
Recent versions of Hugo fails to render `troubleshooting.md` when the
`custom-metrics-elements.png` image isn't located in a static directory.
To avoid further complication with the `synchronize.sh` script from the
github.com/prometheus-operator/website project, images are now stored
under `Documentation/img` and the script will copy this directory to the
`static` directory of the website. Any content that wants to include an
image needs to follow the same approach.
The caveat is that the image will not be displayed from the GitHub UI. I
have tried to use page bundles [1] which would circumvent this
limitation but it would involve moving all the individual MarkDown files
into separate directories and rearrange the site's structure.
See also https://github.com/prometheus-operator/website/pull/17
[1] https://gohugo.io/content-management/page-bundles/
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
