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

Add common Tasks to documentation #5383

Merged
merged 26 commits into from
Nov 25, 2023
Merged

Add common Tasks to documentation #5383

merged 26 commits into from
Nov 25, 2023

Conversation

ncapps
Copy link
Contributor

@ncapps ncapps commented Oct 14, 2023

Related issue: #5286

This change adds examples for common tasks when working with Labels, Annotations, Namespaces and Names.

This PR should follow #5368.

@k8s-ci-robot
Copy link
Contributor

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 14, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ncapps. 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 14, 2023
@ncapps ncapps marked this pull request as ready for review October 14, 2023 23:58
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 14, 2023
@ncapps ncapps mentioned this pull request Oct 15, 2023
Closed
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 15, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Oct 15, 2023

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Oct 15, 2023
@natasha41575
Copy link
Contributor

/ok-to-test

@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 Oct 16, 2023
charles-chenzz
charles-chenzz reviewed Oct 19, 2023
View reviewed changes
Copy link
Member

@charles-chenzz charles-chenzz left a comment

Choose a reason for hiding this comment

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

left some minor suggestions

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 19, 2023
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 19, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Oct 19, 2023 •
edited
Loading

Thanks @charles-chenzz for your review and suggestions. I updated all of the "Output" notes.

charles-chenzz
charles-chenzz reviewed Oct 19, 2023
View reviewed changes
Copy link
Member

@charles-chenzz charles-chenzz left a comment

Choose a reason for hiding this comment

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

only the format issue, other LGTM

site/content/en/docs/Tasks/namespaces_and_names.md Show resolved Hide resolved
@charles-chenzz
Copy link
Member

/assign @bugoverdose

annasong20
annasong20 suggested changes Nov 24, 2023
View reviewed changes
Copy link
Contributor

@annasong20 annasong20 left a comment

Choose a reason for hiding this comment

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

@ncapps Looks really, really good!! Last major outstanding remark is about the exact field names, which I should've looked into earlier. Can't wait to get this in!

LMK when I should re-review.

site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
site/content/en/docs/Tasks/labels_and_annotations.md Outdated Show resolved Hide resolved
@ncapps
Copy link
Contributor Author

ncapps commented Nov 24, 2023

Hi @annasong20, Thanks again for continuing to review this one. I updated the Tasks with your feedback.

@annasong20
Copy link
Contributor

/lgtm
/approve
Looks amazing! Thanks for all your work here, @ncapps!!

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 25, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: annasong20, ncapps

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 merged commit bfb00ec into kubernetes-sigs:master Nov 25, 2023
9 checks passed
@ncapps ncapps mentioned this pull request Dec 1, 2023
Merged
@ncapps ncapps deleted the docs/tasks-common branch January 31, 2024 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charles-chenzz charles-chenzz charles-chenzz left review comments

@annasong20 annasong20 annasong20 approved these changes

@koba1t koba1t Awaiting requested review from koba1t

@natasha41575 natasha41575 Awaiting requested review from natasha41575

@bugoverdose bugoverdose Awaiting requested review from bugoverdose

Assignees

@annasong20 annasong20

@bugoverdose bugoverdose

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
Kustomize Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ncapps @k8s-ci-robot @natasha41575 @charles-chenzz @bugoverdose @annasong20