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

Update Cronjob and Multiversion Tutorials samples to Use Status Conditions #4019

Open
camilamacedo86 opened this issue Jul 17, 2024 · 2 comments
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Milestone

Comments

@camilamacedo86
Copy link
Member

camilamacedo86 commented Jul 17, 2024

What do you want to happen?

Currently, we have two samples used in the docs that share the same base:

In order to follow Kubernetes API Conventions and promote best practices, the status fields in these examples should use status conditions similar to those scaffolded by the Deploy Image Plugin.

Here is an example of using status conditions in the API definition:

And here is how status conditions are handled in the controller:

Proposal:
Update the Cronjob and Multiversion tutorials to incorporate StatusConditions as demonstrated in the examples provided. This will ensure that these tutorials are aligned with Kubernetes API conventions and serve as better references for best practices.

Important
See that for we change the CronjobTutorial we need to change the values in the hack. https://github.com/kubernetes-sigs/kubebuilder/tree/master/hack/docs/internal/cronjob-tutorial. The samples are generated and the code with the docs info is added on top when we run make generate. See the makefile target: https://github.com/kubernetes-sigs/kubebuilder/blob/master/Makefile#L82-L84

Extra Labels

No response

@camilamacedo86 camilamacedo86 added kind/feature Categorizes issue or PR as related to a new feature. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Jul 17, 2024
@lohitslohit
Copy link

@camilamacedo86 I am working on this..

@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. and removed good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Jul 19, 2024
@Bharadwajshivam28
Copy link
Member

@camilamacedo86 I am working on this..
/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

3 participants