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

Document Crossplane XRDs we consider part of our management API #3468

Open
marians opened this issue May 31, 2024 · 1 comment
Open

Document Crossplane XRDs we consider part of our management API #3468

marians opened this issue May 31, 2024 · 1 comment
Assignees

Comments

@marians
Copy link
Member

marians commented May 31, 2024

We have XRDs (CompositeResourceDefinitions) in https://github.com/giantswarm/crossplane-gs-apis which can be considered part of our management API, just like CRDs. They should be published in (almost) the same way.

It should be possible to extend our crd-docs-generator for this task.

Open Questions

  • What are the significant differences between XRD and CRD from a user's perspective
  • Should this land in a separate place, or is one area for CRDs and XRDs fine?
@github-project-automation github-project-automation bot moved this to Inbox 📥 in Roadmap May 31, 2024
@weatherhog weatherhog moved this from Inbox 📥 to Backlog 📦 in Roadmap Jun 11, 2024
@mproffitt
Copy link

Related to #3508

Some work on crd-docs-generator has already been done as part of giantswarm/crd-docs-generator#230

This PR cannot be merged until microerror as been replaced in it with errors as microerror has now been deprecated and should be removed from all revisited codebases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog 📦
Development

No branches or pull requests

2 participants