Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use package level marker to include KGO packages in CRDs reference #695

Open
1 task
czeslavo opened this issue Oct 4, 2024 · 0 comments
Open
1 task
Labels

Comments

@czeslavo
Copy link
Contributor

czeslavo commented Oct 4, 2024

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-level

Acceptance Criteria

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant