-
Notifications
You must be signed in to change notification settings - Fork 1.5k
📖 docs: add ClusterClass CRD relationships diagram #13205
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
📖 docs: add ClusterClass CRD relationships diagram #13205
Conversation
The change adds a new diagram to show the ClusterClass's relationships with other CRDs, hopefully making it easier to understand how a ClusterClass fits in with the other resources. I've tested the change with `make server-book` to confirm the image sizing/alignment looks correct. The change also addresses issue kubernetes-sigs#8558.
|
Hi @Kausheel. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Thx! How was the image created and how can we update/maintain it going forward? |
|
Hi @sbueringer ! The image is in SVG file format, which is an open standard supported by any graphics editor (Adobe, Canva, Gimp, Inkscape, etc). I used MacSVG which is an open source editor, but other contributors wanting to update the image in the future can use many other supported editors. The format is XML-based, so all the diagrams/arrows etc can be moved around from any editor without needing access to any "source" files like in other image formats. So you can freely edit the image I uploaded without any dependencies. |
|
Makes sense, thx! /ok-to-test |
|
LGTM label has been added. DetailsGit tree hash: c714605f0906dad221d56d5ed2d1294d345bc354 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbueringer The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What this PR does / why we need it:
The change adds a new diagram to show the ClusterClass's relationships with other CRDs, hopefully making it easier to understand how a ClusterClass fits in with the other resources.
I've tested the change with
make serve-bookto confirm the image sizing/alignment looks correct.Which issue(s) this PR fixes:
Fixes #8558
/area documentation