You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, to include types in the CRD reference, we rely on them to be annotated with a type-level marker +apireference:kgo:include. It can be problematic as we might miss adding the marker on a type while we expect all types defined in the KGO's repository to be included in the reference.
Proposed Solution
crd-ref-docs doesn't support propagating package-level markers to be accessed in templates. elastic/crd-ref-docs#95 aims to add it. Once it's merged and released, we will be able to switch to using a package-level marker and drop the type-level ones.
Problem Statement
Currently, to include types in the CRD reference, we rely on them to be annotated with a type-level marker
+apireference:kgo:include
. It can be problematic as we might miss adding the marker on a type while we expect all types defined in the KGO's repository to be included in the reference.Proposed Solution
crd-ref-docs
doesn't support propagating package-level markers to be accessed in templates. elastic/crd-ref-docs#95 aims to add it. Once it's merged and released, we will be able to switch to using a package-level marker and drop the type-level ones.Additional information
Approach to doing so using the modified
crd-ref-docs
: chore/generate-docs-markdown-from-kconf...chore/generate-docs-package-levelAcceptance Criteria
+apireference:kgo:include-all-types
markerThe text was updated successfully, but these errors were encountered: