Files
stack/components/operator/docs.config.yaml

23 lines
847 B
YAML

processor:
# RE2 regular expressions describing types that should be excluded from the generated documentation.
ignoreTypes:
- "(.*)List$"
- Conditions
- Condition
- AuthConfig # notes/todo(gfyrag): Not exposing that as I think we should use a Setting
# RE2 regular expressions describing type fields that should be excluded from the generated documentation.
ignoreFields:
#- "status$"
- "TypeMeta$"
- conditions
- apiVersion
render:
# Version of Kubernetes to use when generating links to Kubernetes API documentation.
kubernetesVersion: 1.27
# Generate better link for known types
knownTypes:
- name: SecretObjectReference
package: sigs.k8s.io/gateway-api/apis/v1beta1
link: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.SecretObjectReference