Skip to content
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

Merged
merged 1 commit into from
May 21, 2024
Merged

Conversation

B1F030
Copy link
Contributor

@B1F030 B1F030 commented May 20, 2024

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:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 20, 2024
@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 20, 2024
@B1F030
Copy link
Contributor Author

B1F030 commented May 20, 2024

/cc @windsonsea @zhzhuang-zju

@zhzhuang-zju
Copy link
Contributor

/lgtm thanks for your import commit!

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.

I think new documents added in the future need to follow these rules as well, and be formatted as uniformly as possible

Copy link
Member

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

/lgtm
Thanks.

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 21, 2024
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

/approve

@karmada-bot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 21, 2024
@karmada-bot karmada-bot merged commit 78c800c into karmada-io:main May 21, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants