Merge pull request spidernet-io#2849 from spidernet-io/pr/welan/newdoo

update doc

README-zh_CN.md

@@ -23,7 +23,7 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 [ipvlan CNI](https://github.com/containernetworking/plugins/tree/main/plugins/main/ipvlan),
 [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni) 的功能，满足了各种网络需求，使得 underlay 网络方案可应用在**裸金属、虚拟机和公有云环境**中，可为网络 I/O 密集性、低延时应用带来优秀的网络性能，包括**存储、中间件、AI 等应用**。详细的文档可参考[文档站](https://spidernet-io.github.io/spiderpool/)
 
-**为什么 Spiderpool 选择 macvlan、ipvlan、SR-IOV 为 datapath ？**
+## macvlan、ipvlan、SR-IOV 等 datapath 的优势
 
 * macvlan、ipvlan、SR-IOV 是承载 RDMA 网络加速的重要技术，RDMA 能为 AI 应用、延时敏感型应用、网络 I/O 密集型应用带来极大的性能提升，其网络性能大幅超过 overlay 网络解决方案。
 
@@ -35,11 +35,9 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 
 * underlay CNI 可基于宿主机不同的父网卡来创建虚拟机接口，因此可为存储、观测性等网络开销大的应用提供隔离的子网。
 
-<div style="text-align:center">
-  <img src="./docs/images/arch.png" alt="Your Image Description">
-</div>
+## Spiderpool 为 macvlan、ipvlan、SR-IOV CNI 的增强
 
-**Spiderpool 为 macvlan、ipvlan、SR-IOV CNI 增强了什么？**
+![arch](./docs/images/arch.png)
 
 * 简化安装和使用
 
@@ -76,7 +74,7 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 
 * 指标
 
-**Spiderpool 可应用在哪些场景？**
+## Spiderpool 应用的场景
 
 Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能，可参考 [性能报告](./docs/concepts/io-performance-zh_CN.md)。具体可应用在如下：
 
@@ -90,23 +88,11 @@ Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能
 
 ## 快速开始
 
-可参考 [快速搭建](./docs/usage/install/get-started-kind-zh_CN.md) 来使用 Spiderpool
+参考 [快速搭建](./docs/usage/install/get-started-kind-zh_CN.md) 来使用 Spiderpool
 
 参考 [使用](./docs/usage/readme.md) 来了解各种功能的使用方法
 
-## Spiderpool 架构
-
-Spiderpool 拥有清晰的架构设计，包括了如下应用场景：
-
-* Pod 接入若干个 underlay CNI 网卡，接入 underlay 网络
-
-* Pod 接入一个 underlay CNI 和若干个 underlay CNI 网卡，同时接入双网络
-
-* underlay CNI 运行在公有云环境和虚拟机
-
-* 基于 RDMA 进行网络传输
-
-具体可参考 [架构](./docs/concepts/arch-zh_CN.md)
+参考 [架构](./docs/concepts/arch-zh_CN.md)
 
 ## 核心功能
 

README.md

@@ -27,7 +27,7 @@ Spiderpool is an underlay and RDMA network solution for the Kubernetes. It enhan
 [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni), and fulfills various networking needs and enables the utilization of underlay network solutions in **bare metal, virtual machine, and public cloud environments**. Spiderpool delivers exceptional network performance, particularly benefiting network I/O-intensive and low-latency applications like **storage, middleware, and AI**.
 It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more details.
 
-**Why does Spiderpool select macvlan, ipvlan, and SR-IOV as datapaths?**
+## The datapath advantages of macvlan, ipvlan, SR-IOV
 
 * macvlan, ipvlan, and SR-IOV is crucial for supporting RDMA network acceleration. RDMA significantly enhances performance for AI applicaitons, latency-sensitive and network I/O-intensive applications, surpassing overlay network solutions in terms of network performance.
 
@@ -39,11 +39,9 @@ It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more
 
 * Underlay CNI can create virtual interfaces using different parent network interfaces on the host, providing isolated subnets for applications with high network overhead, such as storage and observability.
 
-<div style="text-align:center">
-  <img src="./docs/images/arch.png" alt="Your Image Description">
-</div>
+## Enhancements that Spiderpool offers for macvlan, ipvlan, and SR-IOV CNI
 
-**What enhancements does Spiderpool provide for macvlan, ipvlan, and SR-IOV CNI?**
+![arch](./docs/images/arch.png)
 
 * Simplified installation and usage
 
@@ -79,7 +77,7 @@ It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more
 
 * Metrics
 
-**Which scenarios can Spiderpool be applied in?**
+## Scenarios that Spiderpool could be applied in
 
 Spiderpool, powered by underlay CNI, offers unparalleled network performance compared to overlay CNI solutions, as evidenced in [I/O Performance](./docs/concepts/io-performance.md). It can be effectively applied in various scenarios, including:
 
@@ -95,21 +93,9 @@ Spiderpool, powered by underlay CNI, offers unparalleled network performance com
 
 Refer to [Quick start](./docs/usage/install/get-started-kind.md) to explore Spiderpool quickly.
 
-Refer to [Usage](./docs/usage/readme.md) for kinds of usages.
+Refer to [Usage Index](./docs/usage/readme.md) for usage details.
 
-## Spiderpool Architecture
-
-Spiderpool features a well-designed and comprehensive architecture that caters to various application scenarios, including:
-
-* Pods have multiple underlay CNI network interfaces to establish connections with underlay networks.
-
-* Pods have an underlay CNI and multiple underlay CNI network interfaces, enabling dual-network connectivity.
-
-* Underlay CNIs run in public cloud environments or virtual machines.
-
-* Leverage RDMA for efficient network transmission.
-
-For more detailed information, please refer to [Spiderpool Architecture](./docs/concepts/arch.md).
+Refer to [Spiderpool Architecture](./docs/concepts/arch.md) for more detailed information
 
 ## Major Features
 

docs/README-zh_CN.md

@@ -23,7 +23,7 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 [ipvlan CNI](https://github.com/containernetworking/plugins/tree/main/plugins/main/ipvlan),
 [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni) 的功能，满足了各种网络需求，使得 underlay 网络方案可应用在**裸金属、虚拟机和公有云环境**中，可为网络 I/O 密集性、低延时应用带来优秀的网络性能，包括**存储、中间件、AI 等应用**。详细的文档可参考[文档站](https://spidernet-io.github.io/spiderpool/)
 
-**为什么 Spiderpool 选择 macvlan、ipvlan、SR-IOV 为 datapath ？**
+## macvlan、ipvlan、SR-IOV 等 datapath 的优势
 
 * macvlan、ipvlan、SR-IOV 是承载 RDMA 网络加速的重要技术，RDMA 能为 AI 应用、延时敏感型应用、网络 I/O 密集型应用带来极大的性能提升，其网络性能大幅超过 overlay 网络解决方案。
 
@@ -35,11 +35,9 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 
 * underlay CNI 可基于宿主机不同的父网卡来创建虚拟机接口，因此可为存储、观测性等网络开销大的应用提供隔离的子网。
 
-<div style="text-align:center">
-  <img src="./images/arch.png" alt="Your Image Description">
-</div>
+## Spiderpool 为 macvlan、ipvlan、SR-IOV CNI 的增强
 
-**Spiderpool 为 macvlan、ipvlan、SR-IOV CNI 增强了什么？**
+![arch](./images/arch.png)
 
 * 简化安装和使用
 
@@ -76,7 +74,7 @@ Spiderpool 是一个 kubernetes 的 underlay 和 RDMA 网络解决方案，它
 
 * 指标
 
-**Spiderpool 可应用在哪些场景？**
+## Spiderpool 应用的场景
 
 Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能，可参考 [性能报告](./concepts/io-performance-zh_CN.md)。具体可应用在如下：
 
@@ -90,23 +88,11 @@ Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能
 
 ## 快速开始
 
-可参考 [快速搭建](./usage/install/get-started-kind-zh_CN.md) 来使用 Spiderpool
+参考 [快速搭建](./usage/install/get-started-kind-zh_CN.md) 来使用 Spiderpool
 
 参考 [使用](./usage/readme-zh_CN.md) 来了解各种功能的使用方法
 
-## Spiderpool 架构
-
-Spiderpool 拥有清晰的架构设计，包括了如下应用场景：
-
-* Pod 接入若干个 underlay CNI 网卡，接入 underlay 网络
-
-* Pod 接入一个 underlay CNI 和若干个 underlay CNI 网卡，同时接入双网络
-
-* underlay CNI 运行在公有云环境和虚拟机
-
-* 基于 RDMA 进行网络传输
-
-具体可参考 [架构](./concepts/arch-zh_CN.md)
+参考 [架构](./concepts/arch-zh_CN.md) 来了解架构设计
 
 ## 核心功能
 

docs/README.md

@@ -27,7 +27,7 @@ Spiderpool is an underlay and RDMA network solution for the Kubernetes. It enhan
 [SR-IOV CNI](https://github.com/k8snetworkplumbingwg/sriov-cni), and fulfills various networking needs and enables the utilization of underlay network solutions in **bare metal, virtual machine, and public cloud environments**. Spiderpool delivers exceptional network performance, particularly benefiting network I/O-intensive and low-latency applications like **storage, middleware, and AI**.
 It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more details.
 
-**Why does Spiderpool select macvlan, ipvlan, and SR-IOV as datapaths?**
+## The datapath advantages of macvlan, ipvlan, SR-IOV
 
 * macvlan, ipvlan, and SR-IOV is crucial for supporting RDMA network acceleration. RDMA significantly enhances performance for AI applicaitons, latency-sensitive and network I/O-intensive applications, surpassing overlay network solutions in terms of network performance.
 
@@ -39,11 +39,9 @@ It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more
 
 * Underlay CNI can create virtual interfaces using different parent network interfaces on the host, providing isolated subnets for applications with high network overhead, such as storage and observability.
 
-<div style="text-align:center">
-  <img src="./images/arch.png" alt="Your Image Description">
-</div>
+## Enhancements that Spiderpool offers for macvlan, ipvlan, and SR-IOV CNI
 
-**What enhancements does Spiderpool provide for macvlan, ipvlan, and SR-IOV CNI?**
+![arch](./images/arch.png)
 
 * Simplified installation and usage
 
@@ -79,7 +77,7 @@ It could refer to [website](https://spidernet-io.github.io/spiderpool/) for more
 
 * Metrics
 
-**Which scenarios can Spiderpool be applied in?**
+## Scenarios that Spiderpool could be applied in
 
 Spiderpool, powered by underlay CNI, offers unparalleled network performance compared to overlay CNI solutions, as evidenced in [I/O Performance](./concepts/io-performance.md). It can be effectively applied in various scenarios, including:
 
@@ -95,21 +93,9 @@ Spiderpool, powered by underlay CNI, offers unparalleled network performance com
 
 Refer to [Quick start](./usage/install/get-started-kind.md) to explore Spiderpool quickly.
 
-Refer to [Usage](./usage/readme.md) for kinds of usages.
+Refer to [Usage Index](./usage/readme.md) for usage details.
 
-## Spiderpool Architecture
-
-Spiderpool features a well-designed and comprehensive architecture that caters to various application scenarios, including:
-
-* Pods have multiple underlay CNI network interfaces to establish connections with underlay networks.
-
-* Pods have an underlay CNI and multiple underlay CNI network interfaces, enabling dual-network connectivity.
-
-* Underlay CNIs run in public cloud environments or virtual machines.
-
-* Leverage RDMA for efficient network transmission.
-
-For more detailed information, please refer to [Spiderpool Architecture](./concepts/arch.md).
+Refer to [Spiderpool Architecture](./concepts/arch.md) for more detailed information.
 
 ## Major Features
 

docs/mkdocs.yml

@@ -66,6 +66,13 @@ nav:
           - VWware vSphere: usage/install/cloud/get-started-vmware.md
           - OpenStack: usage/install/cloud/get-started-openstack.md
       - Upgrading: usage/install/upgrade.md
+  - Concepts:
+      - Architecture: concepts/arch.md
+      - IPAM: concepts/ipam-des.md
+      - IPAM Performance: concepts/ipam-performance.md
+      - Plugin coordinator: concepts/coordinator.md
+      - I/O Performance: concepts/io-performance.md
+      - Blogs: concepts/blog.md
   - Usage:
       - SpiderMultusConfig: usage/spider-multus-config.md
       - IPAM of SpiderIPPool: usage/spider-ippool.md
@@ -84,13 +91,6 @@ nav:
       - Access Service for Underlay CNI: usage/underlay_cni_service.md
       - Kubevirt: usage/kubevirt.md
       - FAQ: usage/faq.md
-  - Concepts:
-      - Architecture: concepts/arch.md
-      - IPAM: concepts/ipam-des.md
-      - IPAM Performance: concepts/ipam-performance.md
-      - Plugin coordinator: concepts/coordinator.md
-      - I/O Performance: concepts/io-performance.md
-      - Blogs: concepts/blog.md
   - Reference:
       - Annotations: reference/annotation.md
       - Configmap: reference/configmap.md