Fix some minor nits for docs

kubeovn · May 7, 2021 · 136571d · 136571d
1 parent 7a20fbf
commit 136571d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/docs/OpenStackK8sInterconnection.md b/docs/OpenStackK8sInterconnection.md
@@ -14,13 +14,13 @@ This document is based on Openstack *Victoria* and Kube-OVN *1.7*
 
 # One Openstack with one Kubernetes
 
-#### 1, Run Interconnection Controller in a Kubernetes node which can be accessed by an Openstack gateway node.
+#### 1. Run Interconnection Controller in a Kubernetes node which can be accessed by an Openstack gateway node.
 
 ```shell
 $ docker run --name=ovn-ic-db -d --network=host -v /etc/ovn/:/etc/ovn -v /var/run/ovn:/var/run/ovn -v /var/log/ovn:/var/log/ovn kubeovn/kube-ovn:v1.6.0 bash start-ic-db.sh
 ```
 
-#### 2, Create `ovn-ic-config` for kubernetes cluster in `kube-system` namespace.
+#### 2. Create `ovn-ic-config` for kubernetes cluster in `kube-system` namespace.
 
 ```yaml
 apiVersion: v1
@@ -38,7 +38,7 @@ data:
   auto-route: "true"            # Auto announces routes to all clusters. If set false, you can select announced routes later manually
 ```
 
-#### 3, Create a router for Openstack cluster to connect with Kubernetes, or use an existing router. `router0` is created here as an example.
+#### 3. Create a router for Openstack cluster to connect with Kubernetes, or use an existing router. `router0` is created here as an example.
 
 ```shell
 $ openstack router create router0
@@ -50,7 +50,7 @@ $ openstack router list
 +--------------------------------------+---------+--------+-------+----------------------------------+
 ```
 
-#### 4, Establish ovn interconnection between Openstack and Kubernetes.
+#### 4. Establish ovn interconnection between Openstack and Kubernetes.
 
 ##### 	Set an availability zone name for Openstack at Openstack on central nodes:
 
@@ -106,7 +106,7 @@ $ ovn-nbctl lrp-set-gateway-chassis lrp-lr1-ts1 <gateway name> [priority]
 $ ovn-nbctl set NB_Global . options:ic-route-adv=true options:ic-route-learn=true
 ```
 
-#### 5, Verify
+#### 5. Verify
 
 	List routes in Openstack cluster.
 

diff --git a/docs/development.md b/docs/development.md
@@ -4,15 +4,15 @@
 
 ##### Prerequisites:
 
-1, Kube-OVN is developed by [Go](https://golang.org/) 1.15 and uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependency. Make sure `GO111MODULE="on"`.
+1. Kube-OVN is developed by [Go](https://golang.org/) 1.15 and uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependency. Make sure `GO111MODULE="on"`.
 
-2, We also use [gosec](https://github.com/securego/gosec) to inspects source code for security problems. 
+2. We also use [gosec](https://github.com/securego/gosec) to inspects source code for security problems. 
 
 ```shell
 go get github.com/securego/gosec/v2/cmd/gosec
 ```
 
-3, To minimize image size we use docker experimental buildx features. 
+3. To minimize image size we use docker experimental buildx features. 
 
 	For version < Docker 19.03, please enable it manually through the [reference](https://docs.docker.com/develop/develop-images/build_enhancements/).