-
Notifications
You must be signed in to change notification settings - Fork 591
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
Complete the autogenerated CRD descriptions #1766
Labels
Comments
I checked all our 6 CRDs in this repo:
|
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem Statement
CRDs generated by Kubebuilder have
description
fields for many of the fields.These are already a significant improvement over the manually written CRDs from KIC 1.x, but the use of descriptions is not consistent yet (there doesn't seem to be a key for presence or lack of presence of a description on specific fields).
Proposed Solution
Add descriptions to all fields of all autogenerated CRDs. Alternatively, choose fields not to add descriptions to, in a consequent manner.
Acceptance Criteria
kubectl explain
with all our CRDs.The text was updated successfully, but these errors were encountered: