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

Complete the autogenerated CRD descriptions #1766

Closed
1 task
mflendrich opened this issue Aug 27, 2021 · 1 comment · Fixed by #2463
Closed
1 task

Complete the autogenerated CRD descriptions #1766

mflendrich opened this issue Aug 27, 2021 · 1 comment · Fixed by #2463

Comments

@mflendrich
Copy link
Contributor

mflendrich commented Aug 27, 2021

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

  • User of our autogenerated CRDs has a consistent experience when using kubectl explain with all our CRDs.
@randmonkey
Copy link
Contributor

randmonkey commented Apr 28, 2022

I checked all our 6 CRDs in this repo:

  • kongclusterplugin
  • kongconsumer
  • kongingress
  • kongplugin
  • tcpingress
  • udpingress
    fields of kongingress does not have descriptions, and other CRDs and their fields have descriptions. So we would update the descriptions of kongingress.

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

Successfully merging a pull request may close this issue.

3 participants