1
0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 06:45:27 +01:00
Files
prometheus-operator/.mdox.validate.yaml

18 lines
586 B
YAML
Raw Permalink Normal View History

version: 1
timeout: "1m"
parallelism: 10
random_delay: 1s
explicitLocalValidators: true
validators:
# Ignore all external URLs because of rate-limiting protections which make the tests very flaky.
- regex: '^http(s)?://.+'
type: "ignore"
# Ignore links to /img/ because the generated content will resolve them correctly.
- regex: '/img/.+'
type: ignore
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
# Ignore anchor links pointing to the API documentation which are HTML <a> tags and not supported by mdox.
- regex: 'api\.md#monitoring\.coreos\.com/v1\.(BasicAuth|PrometheusSpec|StorageSpec)$'
type: ignore