Document Specification¶
In order to ensure a consistent document style, please follow the following style guidelines when submitting documents.
Punctuation¶
All punctuation in the text content in Chinese documents should use Chinese format punctuation, and all text content in English documents should use English punctuation.
Bad | Good |
---|---|
Here is a one-click installation script that can help you quickly install a highly available, production-ready container network. | Here is a one-click installation script that can help you quickly install a highly available, production-ready container network. |
English numbers and Chinese characters should be separated by spaces.
Bad | Good |
---|---|
Kube-OVN provides a one-click installation script to install version 1.10 of Kube-OVN. | Kube-OVN provides a one-click installation script to install version 1.10 of Kube-OVN. |
Example content should start with :
, other sentences should end with .
End.
Bad | Good |
---|---|
Please confirm that the environment configuration is correct before installation Download the installation script using the command below.
| Please confirm that the environment configuration is correct before installation. Download the installation script using the following command:
|
Code Block¶
yaml code blocks need to be identified as yaml.
Bad | Good |
---|---|
|
|
Command-line manipulation example code blocks need to be identified as bash.
Bad | Good |
---|---|
|
|
If the command line operation example contains output content, the executed command needs to start with #
to distinguish input from output.
Bad | Good |
---|---|
|
|
If the command line operation example only contains execution commands and no output results, multiple commands do not need to start with #
.
Bad | Good |
---|---|
|
|
Link¶
Links in the site use the corresponding md
file path.
Bad | Good |
---|---|
|
|
Bad | Good |
---|---|
|
|
Empty Line¶
Different logical blocks, such as title and text, text and code, text and number need to be separated by blank lines.
Bad | Good |
---|---|
|
|
Separate logical blocks with only one blank line.
Bad | Good |
---|---|
|
|
微信群 Slack Twitter Support Meeting