Skip to content

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.

BadGood
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.

BadGood
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.

BadGood
Please confirm that the environment configuration is correct before installation Download the installation script using the command below. 
wget 127.0.0.1
Please confirm that the environment configuration is correct before installation. Download the installation script using the following command: 
wget 127.0.0.1

Code Block

yaml code blocks need to be identified as yaml.

BadGood
 
````
apiVersion: kubeovn.io/v1
kind: Subnet
metadata:
     name: attach-subnet
````

````yaml
apiVersion: kubeovn.io/v1
kind: Subnet
metadata:
     name: attach-subnet
````

Command-line manipulation example code blocks need to be identified as bash.

BadGood
 
````
wget 127.0.0.1
````

````bash
wget 127.0.0.1
````

If the command line operation example contains output content, the executed command needs to start with # to distinguish input from output.

BadGood
 
oilbeater@macdeMac-3 ~ ping 114.114.114.114 -c 3
PING 114.114.114.114 (114.114.114.114): 56 data bytes
64 bytes from 114.114.114.114: icmp_seq=0 ttl=83 time=10.429 ms
64 bytes from 114.114.114.114: icmp_seq=1 ttl=79 time=11.360 ms
64 bytes from 114.114.114.114: icmp_seq=2 ttl=76 time=10.794 ms

--- 114.114.114.114 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 10.429/10.861/11.360/0.383 ms

# ping 114.114.114.114 -c 3
PING 114.114.114.114 (114.114.114.114): 56 data bytes
64 bytes from 114.114.114.114: icmp_seq=0 ttl=83 time=10.429 ms
64 bytes from 114.114.114.114: icmp_seq=1 ttl=79 time=11.360 ms
64 bytes from 114.114.114.114: icmp_seq=2 ttl=76 time=10.794 ms

--- 114.114.114.114 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 10.429/10.861/11.360/0.383 ms

If the command line operation example only contains execution commands and no output results, multiple commands do not need to start with #.

BadGood
 
# mv /etc/origin/ovn/ovnnb_db.db /tmp
# mv /etc/origin/ovn/ovnsb_db.db /tmp

mv /etc/origin/ovn/ovnnb_db.db /tmp
mv /etc/origin/ovn/ovnsb_db.db /tmp

Links in the site use the corresponding md file path.

BadGood
 
Please refer to [Preparation](http://kubeovn.github.io/prepare) before installation.

Please refer to [Preparation](./prepare.md) before installation.
BadGood
 
If you have any questions, please refer to [Kubernetes Documentation](http://kubernetes.io).

If you have any questions, please refer to [Kubernetes Documentation](http://kubernetes.io){: target="_blank" }.

Empty Line

Different logical blocks, such as title and text, text and code, text and number need to be separated by blank lines.

BadGood
 
Download the script below to install it:
```bash
wget 127.0.0.1
```

Download the script below to install it:

```bash
wget 127.0.0.1
```

Separate logical blocks with only one blank line.

BadGood
 
Download the script below to install it:



```bash
wget 127.0.0.1
```

Download the script below to install it:

```bash
wget 127.0.0.1
```

微信群 Slack Twitter Support

Comments