* Create Interface between Prometheus and PrometheusAgent
* Refactor: Use PrometheusInterface to generate configuration
* Hide PrometheusInterface from API documentation
Signed-off-by: Arthur Silva Sens <arthursens2005@gmail.com>
* Documentation: add more content to online docs
This change adds the following content to prometheus-operator.dev website:
* New "User Guides" section with the "Getting Started" and "Alerting" guides.
I've updated/cleaned up the existing content to match with the current
release of the operator.
* "Storage" and "Strategic Merge Patch" pages to the Operator section.
The "Storage" page also documents how to manually expand statefulset volumes
(related to #4079).
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
* Address Philip's comments
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
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>
