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

Add CLI page to Reference Section #5304

Merged
merged 3 commits into from
Sep 23, 2023
Merged

Conversation

ncapps
Copy link
Contributor

@ncapps ncapps commented Aug 31, 2023

This change consolidates Commands content on a single page to resolve #5278.

I used the kubectl CLI page as inspiration for the content layout.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 31, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @ncapps!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@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 Aug 31, 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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 31, 2023
@k8s-ci-robot k8s-ci-robot requested review from koba1t and yuwenma August 31, 2023 23:19
Copy link
Member

@bugoverdose bugoverdose left a comment

Choose a reason for hiding this comment

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

Just a minor comment.

site/content/en/docs/Reference/kustomize_cli.md Outdated Show resolved Hide resolved
@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.

@ncapps
Copy link
Contributor Author

ncapps commented Sep 5, 2023

Hi @bugoverdose, Thanks for your input! I updated everything per your comments.

Start operations section

Refine operations section

Add common operations

Address comments
@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. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 6, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 14, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Sep 14, 2023

Hi @bugoverdose, I believe that I addressed your comments. Would you please review when you get a chance? If you are good with the changes, would you please add a /lgtm comment?

Copy link
Member

@bugoverdose bugoverdose left a comment

Choose a reason for hiding this comment

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

Hi sorry I was a bit late. Can you check the Reference/CLI/_index.md page?

It was added from another PR, and I think we should migrate the content in Reference/kustomize_cli.md to Reference/CLI/_index.md

image

Update the CLI description
@ncapps
Copy link
Contributor Author

ncapps commented Sep 15, 2023

Hi sorry I was a bit late. Can you check the Reference/CLI/_index.md page?

It was added from another PR, and I think we should migrate the content in Reference/kustomize_cli.md to Reference/CLI/_index.md

image

@bugoverdose Thank you for pointing this out. I moved the content to the CLI index.
Screenshot 2023-09-15 at 7 42 03 AM

@ncapps ncapps requested a review from bugoverdose September 15, 2023 14:43
@bugoverdose
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Sep 20, 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 Sep 20, 2023
@annasong20
Copy link
Contributor

Looks great, thanks @ncapps! Taking an iterative approach, anyone who wants more detail can add it later.
/approve

@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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 23, 2023
@k8s-ci-robot k8s-ci-robot merged commit e3b9afc into kubernetes-sigs:master Sep 23, 2023
5 checks passed
@ncapps ncapps mentioned this pull request Dec 1, 2023
@ncapps ncapps deleted the docs/cli branch December 2, 2023 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
Development

Successfully merging this pull request may close these issues.

Document CLI section of Reference
5 participants