-
Notifications
You must be signed in to change notification settings - Fork 1
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
STP-3553: Change command prompts to match docs-csm #123
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we remove the command prompt from the code blocks, we need to still differentiate between the command that the user must execute and the example output of that command.
I left some suggestions on how to handle that. You can also check with the writer for docs-csm to make sure my suggestion is reasonable and aligned with the strategy used there.
549ed1d
to
8763435
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My comments are minor. The bulk of them are just suggestions that instead of specifying the bash
language for example output, we just use screen
. Technically, I don't think screen
is a real supported language according to the GitHub-flavored Markdown docs and the Linguist languages.yml it links to. But it seems to be a convention we use. We could probably use text
instead of screen
and get the same effect where syntax highlighting does not occur.
8763435
to
12cb729
Compare
Signed-off-by: Jessica Dehn <jessica.dehn@hpe.com>
12cb729
to
07cb3a4
Compare
/backport release/2.6 |
Backporting into branch release/2.6 was successful. New PR: #124 |
Summary and Scope
Switched to the command prompt approach used in
docs-csm
. The command itself does not include the prompt, but the step or paragraph which introduces the command is annotated with where the command should be executed. This allows the admin to easily copy and paste the entire code block to get the command they want to run.Issues and Related PRs
release/2.6
Testing
Lint and spell check
Pull Request Checklist