elastic / elastic/crd-ref-docs

Adding `fieldPath` to CRD validation rules removes the whole API group doc

Open
#94 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

### Problem statement

controller-tools 0.16.0 introduced support for `fieldPath` in CRD validation rules: https://github.com/kubernetes-sigs/controller-tools/pull/932

When adding those code markers `crd-ref-docs` **removes the whole API group documentation** for some reason.

### Acceptance criteria

- [ ] As a user I can use `fieldPath` for my CRD validation rules and get documentation generated using `crd-ref-docs`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.