Merge pull request #2594 from ty-dc/docs/format-upgrade

docs: format upgrade doc and error link
spidernet-io · Nov 8, 2023 · 288bd86 · 288bd86
2 parents f11a5ff + feaec7f
commit 288bd86
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 16 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -75,7 +75,6 @@ nav:
       - MultipleInterfaces: usage/multi-interfaces-annotation.md
       - Egress Policy: usage/egress.md
       - Route Support: usage/route.md
-      - Service Support: usage/service.md
       - Node-based Topology: usage/network-topology.md
       - RDMA: usage/rdma.md
       - Access Service for Underlay CNI: usage/underlay_cni_service.md

diff --git a/docs/usage/install/upgrade.md b/docs/usage/install/upgrade.md
@@ -82,7 +82,7 @@ The following steps will describe how to upgrade all of the components from one
 
     (Optional) Spiderpool chart version has changed, you can get the latest stable version with the following command, unzip the chart package and apply all crds.
 
-     ```bash
+    ```bash
     ~# helm search repo spiderpool --versions
     ...
     ~# helm fetch spiderpool/spiderpool --version <upgraded-version>

diff --git a/docs/usage/readme-zh_CN.md b/docs/usage/readme-zh_CN.md
@@ -28,9 +28,9 @@
 
 - [创建集群：基于 kind 集群的双网络](./install/underlay/get-started-kind-zh_CN.md)
 
-- [创建集群：基于 calico 和 macvlan CNI 的双网络](./install/overlay/get-started-calico.md)
+- [创建集群：基于 calico 和 macvlan CNI 的双网络](./install/overlay/get-started-calico-zh_cn.md)
 
-- [创建集群：基于 Cilium 和 macvlan CNI 的双网络](./install/overlay/get-started-cilium.md)
+- [创建集群：基于 Cilium 和 macvlan CNI 的双网络](./install/overlay/get-started-cilium-zh_cn.md)
 
 ### 在虚拟机和公有云环境上基于 Underlay CNI 安装 Spiderpool
 
@@ -122,7 +122,7 @@
   [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni),
   [ovs CNI](https://github.com/k8snetworkplumbingwg/ovs-cni) 等，
   提供了基于 kube-proxy 和 eBPF kube-proxy replacement 访问 ClusterIP 访问，并联通 Pod 和宿主机通信，解决 Pod 健康检查问题。
-  可参考[例子](./service-zh_CN.md)。
+  可参考[例子](./underlay_cni_service-zh_CN.md)。
 
 - 能够帮助实施 IP 地址冲突检测、网关可达性检测，以保证 Pod 通信正常，可参考[例子](../concepts/coordinator.md)。
 

diff --git a/docs/usage/readme.md b/docs/usage/readme.md
@@ -121,7 +121,7 @@ For instructions on how to upgrade Spiderpool, please refer to the [upgrade guid
 [vlan CNI](https://github.com/containernetworking/plugins/tree/main/plugins/main/vlan),
 [ipvlan CNI](https://github.com/containernetworking/plugins/tree/main/plugins/main/ipvlan),
 [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni),
-[ovs CNI](https://github.com/k8snetworkplumbingwg/ovs-cni). This allows seamless communication between Pods and the host machine, thereby resolving Pod health check issues. Refer to the [example](./service.md) for details.
+[ovs CNI](https://github.com/k8snetworkplumbingwg/ovs-cni). This allows seamless communication between Pods and the host machine, thereby resolving Pod health check issues. Refer to the [example](./underlay_cni_service.md) for details.
 
 - Spiderpool assists in IP address conflict detection and gateway reachability checks, ensuring uninterrupted Pod communication. Refer to the [example](../concepts/coordinator.md) for details.
 

diff --git a/docs/usage/service-zh_CN.md b/docs/usage/service-zh_CN.md
diff --git a/docs/usage/service.md b/docs/usage/service.md
diff --git a/docs/usage/underlay_cni_service-zh_CN.md b/docs/usage/underlay_cni_service-zh_CN.md
@@ -1,4 +1,4 @@
-# Underlay CNI 访问 Service 
+# Underlay CNI 访问 Service
 
 **简体中文** | [**English**](./underlay_cni_service.md)
 
@@ -115,7 +115,7 @@ default via 169.254.1.1 dev eth0
 > 注意: 需要确保集群节点的内核版本至少大于 4.19
 
 提前准备好一个未安装 kube-proxy 组件的集群，如果已经安装 kube-proxy 可参考一下命令删除 kube-proxy 组件
-   
+
 ```shell
 ~# kubectl delete ds -n kube-system kube-proxy
 ~# # 在每个节点上运行
@@ -124,7 +124,7 @@ default via 169.254.1.1 dev eth0
 
 也可以使用 kubeadm 安装一个新集群, 注意不要安装 kube-proxy:
 
-```
+```shell
 ~# kubeadm init --skip-phases=addon/kube-proxy
 ```
 
@@ -144,7 +144,7 @@ default via 169.254.1.1 dev eth0
 ```
 
 安装完成，检查安装状态：
-      
+
 ```shell
 ~# kubectl  get po -n kube-system | grep cilium
 cilium-2r6s5                             1/1     Running     0              15m