Skip to content

Edits to cli_operations doc #397

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

Merged
merged 1 commit into from
May 28, 2015
Merged

Conversation

bfallonf
Copy link

PR in regards to this dev PR: #332

Fixed the "Common CLI Operations" table and formatting for the whole doc.

@bfallonf bfallonf changed the title [pee review] Edits to cli_operations doc [peer review] Edits to cli_operations doc May 22, 2015
@@ -14,7 +14,7 @@ This topic provides information on some general CLI operations and their syntax.
You must link:get_started_cli.html[setup and login] with the CLI before you can
perform these operations.

== Common Operations
== Common operations
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we no longer doing title case? And if not, I see you left title case in the table headings; intentional?

@bfallonf bfallonf force-pushed the label_stop_commands branch from 1171b57 to 7668d04 Compare May 25, 2015 01:27
@bfallonf
Copy link
Author

@adellape Ugh, sorry. I got confused for a second. Title case fixed now.

Management Console as "Openshift 3 Sample", with `test-admin` as the project
admin and launches any pods onto nodes matching label `environment : test`.
Management Console as "OpenShift 3 Sample" with `test-admin` as the project
administrator. Any pods are launched onto nodes with the matching label

Choose a reason for hiding this comment

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

Passive voice.

Could you write this instead?

"Pods launch onto nodes with the matching label...."

What's the purpose of saying "any"?

@tpoitras
Copy link

Just one minor thing. Other than that, LGTM. 👍

@bfallonf bfallonf force-pushed the label_stop_commands branch from 7668d04 to 6767bf5 Compare May 25, 2015 22:46
@bfallonf
Copy link
Author

@tpoitras Cool. Thanks for that. Changed the whole para to:

"The following example creates a new project called test that appears in the Management Console as "OpenShift 3 Sample". test-admin is the project administrator and, when launched onto nodes, pods receive the matching label of environment : test:"

@tpoitras
Copy link

@bfallonf -- It's not wrong, and I've done this too, but is it weird or bad style for us to begin a sentence with a file name or sys item name that is lower case? It looks wrong to me, but I don't know if it's worth always re-wording around such things so you never start a sentence with a lower-case file name.

@bfallonf bfallonf force-pushed the label_stop_commands branch from 6767bf5 to e1151fb Compare May 27, 2015 03:50
@bfallonf bfallonf force-pushed the label_stop_commands branch from e1151fb to 840580e Compare May 27, 2015 03:53
@bfallonf
Copy link
Author

@tpoitras At first I agreed with you, and made some changes, but then i saw the end result and liked it less so changed it back. I think it's ok how it is. If there wasn't markup around the test-admin then it might be a different story, but as there is, it looks like 'test-admin' and I think that makes it ok.

If anyone disagrees let me know.

@adellape
Copy link
Contributor

LGTM, merging.

@adellape adellape changed the title [peer review] Edits to cli_operations doc Edits to cli_operations doc May 28, 2015
adellape added a commit that referenced this pull request May 28, 2015
@adellape adellape merged commit c84c5dd into openshift:master May 28, 2015
@bfallonf bfallonf deleted the label_stop_commands branch May 28, 2015 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants