文档规范
为了保证文档风格一致，请在提交文档时遵循下列的风格规范。
标点
中文文档中文本内容所有标点应使用中文格式标点，英文文档中所有文本内容中应使用英文标点。
| Bad | Good |
|---|
| 这里提供了一键安装脚本,可以帮助你快速安装一个高可用,生产就绪的容器网络. | 这里提供了一键安装脚本，可以帮助你快速安装一个高可用，生产就绪的容器网络。 |
英文数字和中文应该用空格进行分隔。
| Bad | Good |
|---|
| Kube-OVN提供了一键安装脚本来安装1.10版本Kube-OVN。 | Kube-OVN 提供了一键安装脚本来安装 1.10 版本 Kube-OVN。 |
示例内容应该以 ： 开启，其他句尾需要用 。 结束。
| Bad | Good |
|---|
| 安装前请确认环境配置正确 使用下面的命令下载安装脚本。 | 安装前请确认环境配置正确。 使用下面的命令下载安装脚本： |
代码块
yaml 代码块需要标识为 yaml。
| Bad | Good |
|---|
````yaml
apiVersion: kubeovn.io/v1
kind: Subnet
metadata:
name: attach-subnet
````
| ````yaml
apiVersion: kubeovn.io/v1
kind: Subnet
metadata:
name: attach-subnet
````
|
命令行操作示例代码块需要标识为 bash。
| Bad | Good |
|---|
| | ````bash
wget 127.0.0.1
````
|
如果命令行操作示例中包含输出内容，则所执行命令需要以 # 开始，以区分输入与输出。
| Bad | Good |
|---|
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
|
如果命令行操作示例中只包含执行命令，没有输出结果，则多条命令无需 # 开始。
| Bad | Good |
|---|
# 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
|
链接
站内链接使用对应 md 文件路径。
| Bad | Good |
|---|
安装前请参考[准备工作](http://kubeovn.github.io/prepare)。
| 安装前请参考[准备工作](./prepare.md)。
|
| Bad | Good |
|---|
如有问题请参考 [Kubernetes 文档](http://kubernetes.io)。
| 如有问题请参考 [Kubernetes 文档](http://kubernetes.io){: target="_blank" }。
|
空行
不同逻辑块，例如标题和文本，文本和代码，文本和编号之间需要用空行分隔。
| Bad | Good |
|---|
下载下面的脚本，进行安装：
```bash
wget 127.0.0.1
```
| 下载下面的脚本，进行安装：
```bash
wget 127.0.0.1
```
|
不同逻辑块之间只使用一个空行进行分隔。
| Bad | Good |
|---|
下载下面的脚本，进行安装：
```bash
wget 127.0.0.1
```
| 下载下面的脚本，进行安装：
```bash
wget 127.0.0.1
```
|
微信群 Slack Twitter Support
Last update: May 8, 2023
Created: July 19, 2022