-
Notifications
You must be signed in to change notification settings - Fork 124
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
doc: format command line prompts #605
Conversation
Signed-off-by: B1F030 <[email protected]>
/lgtm thanks for your import commit!
I think new documents added in the future need to follow these rules as well, and be formatted as uniformly as possible |
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.
/lgtm
Thanks.
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.
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango 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 |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Format command line prompts:
If the code block contains only commands, remove the command line prompt
$
/#
;If the code block contains commands and output logs, keep the command line prompt
$
;When the code block is
shell
/sh
/bash
, use$
instead of#
, because#
may be performed as comment in website.Which issue(s) this PR fixes:
related comment
Special notes for your reviewer: