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

Generate CRDs references for KGO and KIC #105

Open
1 of 2 tasks
czeslavo opened this issue Oct 3, 2024 · 3 comments
Open
1 of 2 tasks

Generate CRDs references for KGO and KIC #105

czeslavo opened this issue Oct 3, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@czeslavo
Copy link
Contributor

czeslavo commented Oct 3, 2024

Problem Statement

Now that we have KIC and KGO CRDs living in this repository, we’ll need to find a way to generate sensible documentation from the API definitions we keep here (possibly separating KGO-supported and KIC-supported types so they can still be used in KGO and KIC CRD references).

Proposed Solution

So far we’ve been generating the markdown files for KIC and KGO CRDs using github.com/elastic/crd-ref-docs. The idea I have is to use the same tool, but annotate the CR types with markers telling whether the CRD is supported by KIC/KGO or both (e.g. // +kicsupported, // +kgosupported on a CR type level). We can inspect the markers (it's a native feature of crd-ref-docs) in templates and render docs only for types that a given project supports. Templates will still live in KGO and KIC repositories.

Additional Information

Acceptance Criteria

  • KGO's CRDs markdown reference is rendered from kubernetes-configuration API definitions
  • KIC's CRDs markdown reference is rendered from kubernetes-configuration API definitions
@czeslavo czeslavo changed the title Generate CRDs references for KGO and KIC separately Generate CRDs references for KGO and KIC Oct 3, 2024
@czeslavo czeslavo added the documentation Improvements or additions to documentation label Oct 3, 2024
@czeslavo czeslavo self-assigned this Oct 3, 2024
@czeslavo czeslavo added this to the KGO 1.4 milestone Oct 3, 2024
@czeslavo czeslavo removed this from the KGO v1.4.x milestone Oct 28, 2024
@czeslavo
Copy link
Contributor Author

Removing a KGO 1.4 milestone as it's been done for KGO already while for KIC it will make more sense to be done together with Kong/kubernetes-ingress-controller#6488.

@czeslavo czeslavo removed their assignment Oct 28, 2024
@randmonkey
Copy link
Contributor

Looks like we should also allow KIC 3.4 milestone to refer to issues in the repo.

@pmalek pmalek added this to the KIC v3.4.x milestone Oct 30, 2024
@pmalek
Copy link
Member

pmalek commented Oct 30, 2024

Created https://github.com/Kong/kubernetes-configuration/milestone/3 and assigned it to this issue.

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

No branches or pull requests

3 participants