diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index fe615ce39f5..9665edce611 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -59,7 +59,7 @@ jobs:
- name: Run misspell
run: find ./* -name "*" | xargs misspell -error
- name: Lint markdown files
- run: find ./ -name "*.md" | grep -v enhancements | grep -v .github | xargs mdl -r ~MD010,~MD013,~MD022,~MD024,~MD029,~MD031,~MD032,~MD033,~MD034,~MD036
+ run: find ./ -name "*.md" | grep -v enhancements | grep -v .github
# - name: Check markdown links
# run: |
# set +e
diff --git a/README.md b/README.md
index c6f4fe5d8ca..ec5ebe4f2e2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,6 @@
# openyurtio/openyurt
-
-
-
+![](docs/img/OpenYurt.png)
[![Version](https://img.shields.io/badge/OpenYurt-v1.4.0-orange)](CHANGELOG.md)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
@@ -12,8 +10,6 @@
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/7117/badge)](https://bestpractices.coreinfrastructure.org/projects/7117)
[![](https://img.shields.io/badge/OpenYurt-Check%20Your%20Contribution-orange)](https://opensource.alibaba.com/contribution_leaderboard/details?projectValue=openyurt)
-
-
English | [简体中文](./README.zh.md)
| ![notification](docs/img/bell-outline-badge.svg) What is NEW! |
@@ -23,9 +19,7 @@ English | [简体中文](./README.zh.md)
[OpenYurt](https://openyurt.io) is built based on upstream Kubernetes and now hosted by the Cloud Native Computing Foundation(CNCF) as a [Sandbox Level Project](https://www.cncf.io/sandbox-projects/).
-
-
-
+![OpenYurt Overview](docs/img/overview.png)
OpenYurt has been designed to meet various DevOps requirements against typical edge infrastructures.
It provides consistent user experience for managing the edge applications as if they were running in the cloud infrastructure.
@@ -41,9 +35,7 @@ manage multiple edge nodes residing in the edge sites. Each edge node has modera
run edge applications plus the required OpenYurt components. The edge nodes in a cluster can span
multiple physical regions, which are referred to as `Pools` in OpenYurt.
-
-
-
+![OpenYurt architecture](docs/img/arch.png)
The above figure demonstrates the core OpenYurt architecture. The major components consist of:
@@ -91,13 +83,11 @@ We have also prepared a developer [guide](https://openyurt.io/docs/developer-man
If you have any questions or want to contribute, you are welcome to communicate most things via GitHub issues or pull requests.
Other active communication channels:
-- Mailing List: https://groups.google.com/g/openyurt/
-- Slack: [OpenYurt channel](https://join.slack.com/t/openyurt/shared_invite/zt-2ajsy47br-jl~zjumRsCAE~BlPRRsIvg) (_English_)
-- DingTalk:Search GroupID `12640034121` (_Chinese_)
+* Mailing List: https://groups.google.com/g/openyurt/
+* Slack: [OpenYurt channel](https://join.slack.com/t/openyurt/shared_invite/zt-2ajsy47br-jl~zjumRsCAE~BlPRRsIvg) (_English_)
+* DingTalk:Search GroupID `12640034121` (_Chinese_)
-
-
-
+![dingtalk](docs/img/ding.jpg)
## License
diff --git a/README.zh.md b/README.zh.md
index ccdfd5837f3..74c1f2c5f12 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -1,8 +1,6 @@
# openyurtio/openyurt
-
-
-
+![](docs/img/OpenYurt.png)
[![Version](https://img.shields.io/badge/OpenYurt-v1.4.0-orange)](CHANGELOG.md)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
@@ -12,8 +10,6 @@
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/7117/badge)](https://bestpractices.coreinfrastructure.org/projects/7117)
[![](https://img.shields.io/badge/OpenYurt-%E6%9F%A5%E7%9C%8B%E8%B4%A1%E7%8C%AE%E6%8E%92%E8%A1%8C%E6%A6%9C-orange)](https://opensource.alibaba.com/contribution_leaderboard/details?projectValue=openyurt)
-
-
[English](./README.md) | 简体中文
| ![notification](docs/img/bell-outline-badge.svg) What is NEW! |
@@ -23,9 +19,7 @@
OpenYurt (官网: https://openyurt.io) 是基于 Upstream Kubernetes 构建的,现在是托管在云原生基金会(CNCF) 下的 [沙箱项目](https://www.cncf.io/sandbox-projects/).
-
-
-
+![OpenYurt Overview](docs/img/overview.png)
OpenYurt 是为满足典型边缘基础设施的各种 DevOps 需求而设计的。
通过 OpenYurt 来管理边缘应用程序,用户可以获得与中心式云计算应用管理一致的用户体验。
@@ -39,9 +33,7 @@ OpenYurt 遵循经典的云边一体化架构。
每个边缘节点都具有适量的计算资源,从而可以运行边缘应用以及 OpenYurt 系统组件。集群中的边缘节点可以分布在多个物理区域,这些物理区域在 OpenYurt 中称为 Pools。
集群中的边缘节点可以分处于在多个物理区域中(region)。
-
-
-
+![OpenYurt architecture](docs/img/arch.png)
上图展示了 OpenYurt 的核心架构。OpenYurt 的主要组件包括:
@@ -92,9 +84,7 @@ OpenYurt 集群安装分成 2 个部分,分别为安装 OpenYurt 管控组件
- Slack: [OpenYurt channel](https://join.slack.com/t/openyurt/shared_invite/zt-25tm2q1dz-Jn6y4r7W4JigWc0Sx2jDzg) (_English_)
- DingTalk: 搜索群 ID `12640034121` (_Chinese_)
-
-
-
+![](docs/img/ding.jpg)
## 许可证