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.

Sign up for GitHub

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

Jump to bottom

Document Struct fields in CRD spec #273

Closed
ytsarev opened this issue Feb 1, 2021 · 0 comments · Fixed by #275
Closed

Document Struct fields in CRD spec #273

ytsarev opened this issue Feb 1, 2021 · 0 comments · Fixed by #275
Labels
enhancement New feature or request
Milestone
0.8

Comments

@ytsarev
Copy link
Member

ytsarev commented Feb 1, 2021

Looking at https://doc.crds.dev/github.com/absaoss/k8gb/k8gb.absa.oss/Gslb/v1beta1@v0.7.2 it is visible that some parts of Gslb spec are totally undocumented or contain automatically generated operator-sdk documentation placeholders.

We need to update api/v1beta1/gslb_types.go with proper documentation comments.
@ytsarev ytsarev added the enhancement New feature or request label Feb 1, 2021
@ytsarev ytsarev added this to the 0.8 milestone Feb 1, 2021
ytsarev added a commit that referenced this issue Feb 2, 2021
@ytsarev
Update embedded doc strings in CRD spec
7ebbad1 
* Fixes #273
ytsarev added a commit that referenced this issue Feb 2, 2021
@ytsarev
Update embedded doc strings in CRD spec
f541380 
* Fixes #273

Signed-off-by: Yury Tsarev <yury.tsarev@absa.africa>
@ytsarev ytsarev mentioned this issue Feb 2, 2021
Merged
ytsarev added a commit that referenced this issue Feb 2, 2021
@ytsarev
Update embedded doc strings in CRD spec (#275)
195c353 
* Fixes #273

Signed-off-by: Yury Tsarev <yury.tsarev@absa.africa>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
0.8
Development

Successfully merging a pull request may close this issue.

Update embedded doc strings in CRD spec k8gb-io/k8gb
1 participant
@ytsarev