Skip to content

Commit

Permalink
fix: update md lint
Browse files Browse the repository at this point in the history
Signed-off-by: fengshunli <[email protected]>
  • Loading branch information
fengshunli committed Apr 16, 2024
1 parent c0e8d33 commit d579557
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# openyurtio/openyurt

<div align="center">

<img src="docs/img/OpenYurt.png" width="400" height="94"><br/>
![](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)
Expand All @@ -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)

</div>

English | [简体中文](./README.zh.md)

| ![notification](docs/img/bell-outline-badge.svg) What is NEW! |
Expand All @@ -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/).

<div align="left">
<img src="docs/img/overview.png" width=80% title="OpenYurt Overview ">
</div>
![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.
Expand All @@ -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.

<div align="left">
<img src="docs/img/arch.png" width=70% title="OpenYurt architecture">
</div>
![OpenYurt architecture](docs/img/arch.png)

The above figure demonstrates the core OpenYurt architecture. The major components consist of:

Expand Down Expand Up @@ -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_)

<div align="left">
<img src="docs/img/ding.jpg" width=25% title="dingtalk">
</div>
![dingtalk](docs/img/ding.jpg)

## License

Expand Down
18 changes: 4 additions & 14 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# openyurtio/openyurt

<div align="center">

<img src="docs/img/OpenYurt.png" width="400" height="94"><br/>
![](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)
Expand All @@ -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)

</div>

[English](./README.md) | 简体中文

| ![notification](docs/img/bell-outline-badge.svg) What is NEW! |
Expand All @@ -23,9 +19,7 @@

OpenYurt (官网: https://openyurt.io) 是基于 Upstream Kubernetes 构建的,现在是托管在云原生基金会(CNCF) 下的 [沙箱项目](https://www.cncf.io/sandbox-projects/).

<div align="left">
<img src="docs/img/overview.png" width=80% title="OpenYurt Overview ">
</div>
![OpenYurt Overview](docs/img/overview.png)

OpenYurt 是为满足典型边缘基础设施的各种 DevOps 需求而设计的。
通过 OpenYurt 来管理边缘应用程序,用户可以获得与中心式云计算应用管理一致的用户体验。
Expand All @@ -39,9 +33,7 @@ OpenYurt 遵循经典的云边一体化架构。
每个边缘节点都具有适量的计算资源,从而可以运行边缘应用以及 OpenYurt 系统组件。集群中的边缘节点可以分布在多个物理区域,这些物理区域在 OpenYurt 中称为 Pools。
集群中的边缘节点可以分处于在多个物理区域中(region)。

<div align="left">
<img src="docs/img/arch.png" width=70% title="OpenYurt architecture">
</div>
![OpenYurt architecture](docs/img/arch.png)

上图展示了 OpenYurt 的核心架构。OpenYurt 的主要组件包括:

Expand Down Expand Up @@ -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_)

<div align="left">
<img src="docs/img/ding.jpg" width=25% title="dingtalk">
</div>
![](docs/img/ding.jpg)

## 许可证

Expand Down

0 comments on commit d579557

Please sign in to comment.