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

modified cmd.Use for kubectl-workspaces #1756

Merged

Conversation

apoorvajagtap
Copy link
Contributor

Summary:

As sub-commands like create/create-context required additional details about workspace, whereas rest of the commands did not. So, the usage section workspace [create|create-context|<workspace>|..|.|-|~|<root:absolute:workspace>] [flags] might lead to a confusion as some sub-commands aren't specified. Modified the usage section as below, using the generic keywords:
Usage: workspace [command] [flags] workspace [command]
Considered keeping (workspace [command]) for commands like use.
Let me know, if we should only keep workspace [command] [flags] instead of both the statements.

Fixes #1579

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 16, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 16, 2022

Hi @apoorvajagtap. Thanks for your PR.

I'm waiting for a kcp-dev 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.

@sttts
Copy link
Member

sttts commented Aug 16, 2022

not everything is a subcommand. So I don't think shortening the help text is the right direction.

@apoorvajagtap
Copy link
Contributor Author

Hi @sttts, thanks for the inputs. I've now added use & current as well to the Usage section. Let me know if this fits better or not. Thanks again!

@sttts
Copy link
Member

sttts commented Sep 1, 2022

/lgtm
/approve
/ok-to-test

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 1, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 1, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sttts

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 1, 2022
@openshift-merge-robot openshift-merge-robot merged commit 6fed1f5 into kcp-dev:main Sep 1, 2022
@apoorvajagtap apoorvajagtap deleted the workspace_usage_section branch September 6, 2022 17:18
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. lgtm 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incomplete Usage message from kubectl kcp workspace plugin
3 participants