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

📖 doc: validating and parsing CRD fields #4396

Merged
merged 1 commit into from
Dec 6, 2024
Merged

📖 doc: validating and parsing CRD fields #4396

merged 1 commit into from
Dec 6, 2024

Conversation

mateusoliveira43
Copy link
Contributor

@mateusoliveira43 mateusoliveira43 commented Nov 26, 2024 •
edited
Loading

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 26, 2024
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 26, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @mateusoliveira43. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions 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.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 26, 2024
camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
docs/book/src/faq.md Outdated Show resolved Hide resolved
camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
docs/book/src/faq.md Outdated Show resolved Hide resolved
camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
docs/book/src/faq.md Outdated Show resolved Hide resolved
camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
docs/book/src/faq.md
Users would have error notification from Kubernetes API when trying to create CRD with wrong `timefield` value, but on developer side, the string value would need parsing prior to usage.

To have both good user and developer experience, it is good to use pre defined types, like [`metav1.Time`](https://pkg.go.dev/k8s.io/apimachinery@v0.31.1/pkg/apis/meta/v1#Time).
For example, consider this code
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, consider this code
**Example**

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added title instead

camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
docs/book/src/faq.md Outdated Show resolved Hide resolved
camilamacedo86
camilamacedo86 reviewed Dec 5, 2024
View reviewed changes
Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mateusoliveira43

kudos+++ Terrific
I just added some nit suggestions more to refine the style for the FAQ
But the content is great !!!

Thank you a lot 🥇

@mateusoliveira43 @camilamacedo86
doc: validating and parsing CRD fields
005b503 
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

Update docs/book/src/faq.md

Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com>

Update docs/book/src/faq.md

Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com>

Update docs/book/src/faq.md

Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com>
@mateusoliveira43 mateusoliveira43 force-pushed the doc/validating-parsing-CRD-fields branch from 535f331 to 005b503 Compare December 6, 2024 19:07
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 6, 2024
camilamacedo86
camilamacedo86 approved these changes Dec 6, 2024
View reviewed changes
Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 6, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 6, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, mateusoliveira43

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 6, 2024
@k8s-ci-robot k8s-ci-robot merged commit 391ad16 into kubernetes-sigs:master Dec 6, 2024
10 checks passed
@camilamacedo86 camilamacedo86 mentioned this pull request Dec 14, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camilamacedo86 camilamacedo86 camilamacedo86 approved these changes

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

Assignees

@camilamacedo86 camilamacedo86

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to represent time and dates in types.
3 participants
@mateusoliveira43 @k8s-ci-robot @camilamacedo86