Fix CLI help issues

[fabianofranz]

Addresses bug 1169685 and all other remaining help issues.

[fabianofranz]

@smarterclayton this addresses the remaining 'help' issues.

[smarterclayton]

can you link the upstream pulls here?

[fabianofranz]

@smarterclayton Upstream PR here: spf13/cobra#51

[fabianofranz]

@smarterclayton Take a look at hack/test-cmd.sh. I added several test cases there to cover all help scenarios, need to make sure that's what we expect and everything is covered.

[smarterclayton]

LGTM - jessica and I brainstormed some help improvements today - can be done in another issue, but things like:

• create global options help command ("options") which we add to "osc", and then omit all globals from the help template, except maybe a few important ones and a generic "osc help options for more" tagline.
• when help shows subcommands, don't show anything except the command name (omit the usage chunks)
• Nuke the usage section on each command, people should always specify their own usage line, and then put other examples. I don't think we can fix this within Cobra without invasive changes, so we can do the simpler option (having it in long desc) now.
• double check all commands for having short descriptions
• get upstream commands to parameterize their short desc with an arg (or we can do a find and replace with a wrapper function for kubectl on specific commands).

[fabianofranz]

[merge]

[openshift-bot]

continuous-integration/openshift-jenkins/merge SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_requests_openshift3/804/) (Image: devenv-fedora_689)

[openshift-bot]

Evaluated for origin up to e2a70de

[fabianofranz]

@smarterclayton Nice, pretty much what I was thinking too. I'll try to keep the invasive changes as much outside of Cobra / parameterized / custom funcs as possible, but I foresee at some point we forking it (already not completely confident I'll get my recent upstream proposals merged).

[fabianofranz]

@smarterclayton I'll copy these brainstorming ideas to a Github issue.

[smarterclayton]

Let's try to delay forking as long as possible.

On Feb 4, 2015, at 9:29 AM, Fabiano Franz notifications@github.com wrote:

@smarterclayton Nice, pretty much what I was thinking too. I'll try to keep the invasive changes as much outside of Cobra / parameterized / custom funcs as possible, but I foresee at some point we forking it (already not completely confident I'll get my recent upstream proposals merged).

—
Reply to this email directly or view it on GitHub.

[smarterclayton]

Can you do a quick pass on the easiest ones here today? I want our help to be reasonable in beta.

On Feb 4, 2015, at 9:31 AM, Fabiano Franz notifications@github.com wrote:

@smarterclayton I'll copy these brainstorming ideas to a Github issue.

—
Reply to this email directly or view it on GitHub.