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

Tidy iexec caveats section #139

Merged
merged 2 commits into from Apr 21, 2019

Conversation

Projects
None yet
3 participants
@gabeduke
Copy link
Contributor

commented Apr 19, 2019

Caveats will display as:

VERSION: v1.0.0
CAVEATS:
\
 |   Documentaion: https://github.com/gabeduke/kubectl-iexec
 |
 |   Usage: `kubectl iexec [pod]`
 |
 |   Flags:
 |     -c, --container string   Container to exec into (defaults to container[0]
 |     -h, --help               help for iexec
 |     -l, --log-level string   log level (trace|debug|info|warn|error|fatal|panic)
 |     -n, --namespace string   Namespace to search
 |     -v, --vimMode            Vim Mode enabled
 |
 |   ##############################################################
 |   # example:                                                   #   
 |   #                                                            #   
 |   #   >> kubectl get pod                                       #   
 |   #   NAME         READY   STATUS        RESTARTS   AGE        #   
 |   #   hello-pod1   1/1     Running       0          37d        #   
 |   #   hello-pod2   1/1     Running       0          37d        #   
 |   #                                                            #   
 |   #   >> kubectl iexec hello                                   #   
 |   #   Use the arrow keys to navigate: ↓ ↑ → ←                  #   
 |   #   ? Select Pod:                                            #   
 |   #     Namespace: default | Pod: hello-pod1                   #   
 |   #     Namespace: default | Pod: hello-pod2                   #   
 |   ##############################################################
 |
/

Checklist for plugin developers:

  • Read the Plugin Naming Guide (for new plugins)
  • Verify the installation from URL or a local archive works (kubectl krew install --manifest=[...] --archive=[...])
@ahmetb

This comment has been minimized.

Copy link
Contributor

commented Apr 19, 2019

I think it looks excessive, especially if you have a -h flag supported.

What do you think your users should know right after installing the plugin? All this info?

@gabeduke

This comment has been minimized.

Copy link
Contributor Author

commented Apr 19, 2019

Sure. I assume you mean the example block. Would you recommend removing any other blocks as well? Or simply leaving as-is.

There is not a good way for a user to 'browse' plugins except to either install or switch context to the git repo in a browser. I was attempting to provide users with a consolidated view from kubectl krew info iexec.

@ahmetb

This comment has been minimized.

Copy link
Contributor

commented Apr 19, 2019

I mean the usage block mostly.

You can simply say:

caveats: |
  Read documentation at: https://github.com/gabeduke/kubectl-iexec
  To get help, run: kubectl iexec --help
  Examples:

  Run a command in a container:
        kubectl exec foo bar

and that would give users a good starting point.

We might go and manually clean up CAVEATS sections to actually only include post-installation caveats (such as installing extra dependencies required), but for now it's a good opportunity show users the "next steps" after installing a plugin.

@gabeduke

This comment has been minimized.

Copy link
Contributor Author

commented Apr 20, 2019

Okay all set - thanks for the tips :)

@ahmetb

This comment has been minimized.

Copy link
Contributor

commented Apr 21, 2019

/lgtm
/approve

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Apr 21, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, gabeduke

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 950653b into kubernetes-sigs:master Apr 21, 2019

2 of 3 checks passed

tide Not mergeable. Needs approved, lgtm labels.
Details
cla/linuxfoundation gabeduke authorized
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.