Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
Signed-off-by: weizhou.lan@daocloud.io <weizhou.lan@daocloud.io>
  • Loading branch information
weizhoublue committed Dec 13, 2023
1 parent c05980b commit c6b16d0
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

## underlay CNI 的优势
## Underlay CNI 的优势

underlay CNI 主要指 macvlan、ipvlan、SR-IOV 等能够直接访问宿主机二层网络的 CNI 技术,它有如下优势:

Expand Down Expand Up @@ -76,7 +76,7 @@ underlay CNI 主要指 macvlan、ipvlan、SR-IOV 等能够直接访问宿主机

* 指标

## Spiderpool 应用的场景
## 应用场景

Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能,可参考 [性能报告](./docs/concepts/io-performance-zh_CN.md)。具体可应用在如下:

Expand Down Expand Up @@ -129,7 +129,7 @@ Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能

可参考 [开发搭建文档](./docs/develop/contributing.md).

## Spiderpool 社区
## 社区

Spiderpool 社区致力于营造一个开放和热情的环境,并通过多种方式与其他用户和开发人员互动。 您可以访问我们的 [社区网站](https://github.com/spidernet-io/community) 了解更多信息

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## The advantages of underlay CNI
## The Advantages Of Underlay CNI

The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud access the layer 2 network of the node. It has some advantages :

Expand All @@ -41,7 +41,7 @@ The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud ac

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

## Major Feaetures
## Major Features

![arch](./docs/images/arch.png)

Expand Down Expand Up @@ -79,7 +79,7 @@ The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud ac

* Metrics

## Scenarios that Spiderpool could be applied in
## Application Scenarios

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:

Expand All @@ -91,7 +91,7 @@ Spiderpool, powered by underlay CNI, offers unparalleled network performance com

* Latency-sensitive application.

## Quick start
## Quick Start

Refer to [Quick start](./docs/usage/install/get-started-kind.md) to explore Spiderpool quickly.

Expand Down Expand Up @@ -132,7 +132,7 @@ A list of adopters who are deploying Spiderpool in production, and of their use

Refer to [Contribution](./docs/develop/contributing.md) to join us for developing Spiderppol.

## Spiderpool community
## Community

The Spiderpool community is committed to fostering an open and welcoming environment, with several ways to engage with other users and developers.
You can find out more information by visiting our [community repository](https://github.com/spidernet-io/community).
Expand Down
6 changes: 3 additions & 3 deletions docs/README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

## underlay CNI 的优势
## Underlay CNI 的优势

underlay CNI 主要指 macvlan、ipvlan、SR-IOV 等能够直接访问宿主机二层网络的 CNI 技术,它有如下优势:

Expand Down Expand Up @@ -76,7 +76,7 @@ underlay CNI 主要指 macvlan、ipvlan、SR-IOV 等能够直接访问宿主机

* 指标

## Spiderpool 应用的场景
## 应用场景

Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能,可参考 [性能报告](./concepts/io-performance-zh_CN.md)。具体可应用在如下:

Expand Down Expand Up @@ -129,7 +129,7 @@ Spiderpool 基于 underlay CNI 提供了比 overlay CNI 还优越的网络性能

可参考 [开发搭建文档](./develop/contributing.md).

## Spiderpool 社区
## 社区

Spiderpool 社区致力于营造一个开放和热情的环境,并通过多种方式与其他用户和开发人员互动。 您可以访问我们的 [社区网站](https://github.com/spidernet-io/community) 了解更多信息

Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## The advantages of underlay CNI
## The Advantages Of Underlay CNI

The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud access the layer 2 network of the node. It has some advantages :

Expand All @@ -41,7 +41,7 @@ The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud ac

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

## Major Feaetures
## Major Features

![arch](./images/arch.png)

Expand Down Expand Up @@ -79,7 +79,7 @@ The underlay CNI is mainly including macvlan, ipvlan, and SR-IOV, which cloud ac

* Metrics

## Scenarios that Spiderpool could be applied in
## Application Scenarios

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:

Expand Down Expand Up @@ -132,7 +132,7 @@ A list of adopters who are deploying Spiderpool in production, and of their use

Refer to [Contribution](./develop/contributing.md) to join us for developing Spiderppol.

## Spiderpool community
## Community

The Spiderpool community is committed to fostering an open and welcoming environment, with several ways to engage with other users and developers.
You can find out more information by visiting our [community repository](https://github.com/spidernet-io/community).
Expand Down

0 comments on commit c6b16d0

Please sign in to comment.