1
0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-06 18:46:40 +01:00

3 Commits

Author SHA1 Message Date
dongjiang
c22d1da263 chore: fix gen-crd-api-reference-docs warning (#7063)
Signed-off-by: dongjiang1989 <dongjiang1989@126.com>
2024-11-06 16:01:06 +05:30
Arthur Silva Sens
f42c786eb4 Generate Prometheus configuration through interface (#5310)
* 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>
2023-02-14 17:27:00 +01:00
Simon Pasquier
69f7061796 Refactor crd api docs (#4899)
* 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>
2022-07-13 14:24:02 +02:00