Update usage for OpenShift CLI #14573
Conversation
openshift-ci-robot
added
the
size/XS
|
@openshift/team-documentation PTAL, thanks. |
jboxman
added
the
peer-review-needed
|
|
||
| The `oc` tool is the command line interface of OpenShift 3 and 4. | ||
|
|
||
| When referencing as a prerequisite for a procedure module, use the following | ||
| construction: Install the OpenShift Command-line Interface (CLI), commonly known |
There was a problem hiding this comment.
Do we need to put a prerequisite of having the CLI installed in front of every single procedure that uses a CLI command? We certainly don't right now. We should determine when to or not to (if not always).
And if we determine that we should always, then I still think that this is overkill: "Install the OpenShift Command-line Interface (CLI), commonly known as oc", as opposed to just "Install the OpenShift CLI (oc)" as the prerequisite. Maybe spelling it out more makes sense in places where we know people are just getting started, but it seems a bit much to use for every procedure.
There was a problem hiding this comment.
I agree that this seems like overkill if we have to add this into every assembly where the oc command is used. To me it's the same as saying that we require a running OpenShift cluster before running commands.
I think on the sections that predominantly focus on the CLI, such as some of the CLI reference bucket, it makes sense. Throughout most of the other guides it feels like overkill, though.
There was a problem hiding this comment.
+1
Installting the CLI is part of the installation, not a specific prerequisite to the task in a given topic.
There was a problem hiding this comment.
I agree that installing the CLI is part of installation, but then only the person installing OpenShift has the CLI installed, not the person completing that specific task. I think it's fair to assume that the cluster is up but not fair to assume that each user has the CLI installed and the correct permissions to perform an action.
There was a problem hiding this comment.
I think that we should pair this prereq with another prereq that states the permission you need to run the commands in the procedure.
vikram-redhat
added
peer-review-done
|
@jboxman - this can be merged or were you thinking of making more changes? |
|
@vikram-redhat, I think everyone has been too busy to make any further suggestions. I haven't had time to decide what changes to make based on the feedback already provided. |
|
@jboxman I don't think we will get more input on this PR. Did you want to either follow up or close? |
|
Based on #16791 (comment) I'm going to merge this; I'd like to revisit the observation about communicating what the relevant security role a user needs. That's important and using consistent language about that would be helpful. |
|
@vikram-redhat, how many branches are we committing the contributing guides to? Just master or each 4.x branch? Thanks. |
|
@jboxman the contribution guides are only in master, so you may need to move this there. |
Update usage based on our recent discussion.