Update en and zh README

Signed-off-by: windsonsea <[email protected]>
kubean-io · May 8, 2024 · d620c38 · d620c38
1 parent 0640787
commit d620c38
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Source: https://github.com/cncf/artwork/tree/master/projects/kubernetes/certifie
 
   <p>
 
-Kubean is a product ready cluster lifecycle management toolchains based on [kubespray](https://github.com/kubernetes-sigs/kubespray) and other cluster LCM engine.
+Kubean is a production-ready cluster lifecycle management toolchain based on [kubespray](https://github.com/kubernetes-sigs/kubespray) and other cluster LCM engine.
 
   </p>
 
@@ -54,43 +54,45 @@ Kubean is a product ready cluster lifecycle management toolchains based on [kube
 - **Compatibility**: Multi-arch delivery Supporting. Such as AMD, ARM with common Linux distributions. Also include Kunpeng with Kylin.
 - **Expandability**: Allowing custom actions be added to cluster without any changes for Kubespray.
 
-## :surfing_man: Quick Start
+## :surfing_man: Quick start
 
-### Killercoda
+### Killercoda tutorials
 
-We created a [scenario](https://killercoda.com/kubean) on [killercoda](https://killercoda.com), which is a online platform for interactive technique learning. You can try it in there.
+We created a [scenario](https://killercoda.com/kubean) on [killercoda](https://killercoda.com), which is an online platform for interactive technique learning. You can try it in there.
 
 ### Local install
 
-#### 1. Ensure that a Kubernetes Cluster exists and Helm installed
+1. Ensure that you have a Kubernetes cluster running, on which Helm is installed
 
-#### 2. Deploy kubean-operator
+2. Deploy kubean-operator
 
-``` shell
-$ helm repo add kubean-io https://kubean-io.github.io/kubean-helm-chart/
-$ helm install kubean kubean-io/kubean --create-namespace -n kubean-system
-```
+   ```shell
+   helm repo add kubean-io https://kubean-io.github.io/kubean-helm-chart/
+   helm install kubean kubean-io/kubean --create-namespace -n kubean-system
+   ```
 
-Then check kubean-operator status by running:
+   Then check kubean-operator status by running:
 
-```shell
-$ kubectl get pods -n kubean-system
-```
+   ```shell
+   kubectl get pods -n kubean-system
+   ```
 
-#### 3. Online mode deployment of minimal all-in-one clusters
+3. Online deploy an all-in-one cluster with minimal configuration
 
-You can use the example in folder `examples/install/1.minimal` which uses online resources to install k8s cluster.
+   1. A simple way is to use [AllInOne.yml](./examples/install/1.minimal/),
+      replacing `<IP1>`, `<USERNAME>`, and other strings with actual values.
 
-1. Modify the `examples/install/1.minimal/AllInOne.yml` file by simply replacing `<IP1>`, `<USERNAME>`,
-   and any other placeholders with their actual values.
-2. Start kubeanClusterOps which will start the kubespray job.
-   ```shell
-   $ kubectl apply -f examples/install/1.minimal
-   ```
-3. Check the kubespray job status.
-   ```shell
-   $ kubectl get job -n kubean-system
-   ```
+   2. Start `kubeanClusterOps` to run the kubespray job.
+
+      ```shell
+      kubectl apply -f examples/install/1.minimal
+      ```
+
+   3. Check the kubespray job status.
+
+      ```shell
+      kubectl get job -n kubean-system
+      ```
 
 [![quick_start_image](docs/overrides/assets/images/quick_start.gif)](https://asciinema.org/a/jFTUi2IdU5yydv88kHkPYMni0)
 
@@ -104,21 +106,22 @@ You can use the example in folder `examples/install/1.minimal` which uses online
 | Kubean v0.4.5 |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |
 | Kubean v0.4.4 |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |        ✓        |
 
-To check the list of Kubernetes versions supported by Kubean, please refer to the [Kubernetes versions list](./docs/zh/usage/support_k8s_version.md).
+To check the list of Kubernetes versions supported by Kubean, refer to the [Kubernetes versions list](./docs/zh/usage/support_k8s_version.md).
 
 ## :book: Roadmap
 
-For detailed information about all the planned features, please refer to the [roadmap](docs/en/develop/roadmap.md).
+For detailed information about all the planned features, refer to the [roadmap](docs/en/develop/roadmap.md).
 
 ## :book: Documents
 
-Please visit: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
+Please visit our website: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
 
-## :envelope: Communication
+## :envelope: Join us
 
 You can connect with us on the following channels:
-  - Slack: join the [#Kubean](https://cloud-native.slack.com/messages/kubean) channel on CNCF Slack by requesting an [invitation](https://slack.cncf.io/) from CNCF Slack. Once you have access to CNCF Slack, you can join the Kubean channel.
-  - Email: refer to the [MAINTAINERS.md](./MAINTAINERS.md) to find the email addresses of all maintainers. Feel free to contact them via email to report any issues or ask questions.
+
+- Slack: join the [#Kubean](https://cloud-native.slack.com/messages/kubean) channel on CNCF Slack by requesting an [invitation](https://slack.cncf.io/) from CNCF Slack. Once you have access to CNCF Slack, you can join the Kubean channel.
+- Email: refer to the [MAINTAINERS.md](./MAINTAINERS.md) to find the email addresses of all maintainers. Feel free to contact them via email to report any issues or ask questions.
 
 ## :thumbsup: Contributors
 
@@ -144,6 +147,6 @@ Kubean enriches the <a href="https://landscape.cncf.io/?selected=kubean">CNCF CL
 </p>
 </div>
 
-
 ## License
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean?ref=badge_large)
diff --git a/README_zh.md b/README_zh.md
@@ -61,34 +61,37 @@ Kubean 是一款准生产的集群生命周期管理工具，基于 [kubespray](
 
 ### 本地安装
 
-#### 1. 确保有一个 Kubernetes 集群且安装了 Helm
+1. 确保有一个 Kubernetes 集群且安装了 Helm
 
-#### 2. 部署 kubean-operator
+2. 部署 kubean-operator
 
-``` shell
-$ helm repo add kubean-io https://kubean-io.github.io/kubean-helm-chart/
-$ helm install kubean kubean-io/kubean --create-namespace -n kubean-system
-```
+   ``` shell
+   helm repo add kubean-io https://kubean-io.github.io/kubean-helm-chart/
+   helm install kubean kubean-io/kubean --create-namespace -n kubean-system
+   ```
 
-检查 kubean-operator 状态：
+   检查 kubean-operator 状态：
 
-```shell
-$ kubectl get pods -n kubean-system | grep 'kubean'
-```
+   ```shell
+   kubectl get pods -n kubean-system | grep 'kubean'
+   ```
 
-#### 3. 在线模式部署最小化单节点集群
+3. 在线模式部署最小化单节点集群
 
-你可以使用 `examples/install/1.minimal` 文件夹中的例子，这些例子使用在线资源安装 K8s 集群。
+   1. 一个简单的方式是使用 [AllInOne.yml](./examples/install/1.minimal/)，
+      替换 `<IP1>`、`<USERNAME>`... 等字符串为真实值。
+
+   2. 启动 `kubeanClusterOps`，这将启动 kubespray job。
 
-1. 修改 `examples/install/1.minimal/AllInOne.yml`，替换 `<IP1>`、`<USERNAME>`... 等字符串为真实值。
-2. 启动 kubeanClusterOps，这将启动 kubespray job。
-   ```shell
-   $ kubectl apply -f examples/install/1.minimal
-   ```
-3. 检查 kubespray job 状态。
-   ```shell
-   $ kubectl get job -n kubean-system
-   ```
+      ```shell
+      kubectl apply -f examples/install/1.minimal
+      ```
+
+   3. 检查 kubespray job 状态。
+
+      ```shell
+      kubectl get job -n kubean-system
+      ```
 
 [![quick_start_image](docs/overrides/assets/images/quick_start.gif)](https://asciinema.org/a/511386)
 
@@ -104,15 +107,22 @@ $ kubectl get pods -n kubean-system | grep 'kubean'
 
 要查看 Kubean 支持的 Kubernetes 版本列表，请参考 [Kubernetes 版本列表](./docs/zh/usage/support_k8s_version.md)。
 
+## :book: 开发路线图
+
+有关功能特性，请参阅 [roadmap](docs/en/develop/roadmap.md)。
+
 ## :book: 参考文档
 
-请浏览: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
+请浏览我们的网站 [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)。
 
 ## :envelope: 联系我们
 
 你可以通过以下渠道与我们联系：
-  - Slack: 通过请求 CNCF Slack的[邀请](https://slack.cncf.io/)加入 CNCF Slack的 [#Kubean](https://cloud-native.slack.com/messages/kubean) 频道。一旦您可以访问 CNCF Slack，您就可以加入 Kubean 频道。
-  - 电子邮件: 请参阅 [MAINTAINERS.md](./MAINTAINERS.md) 查找所有维护人员的电子邮件地址。随时通过电子邮件与他们联系，报告任何问题或提出问题。
+
+- Slack：通过请求 CNCF Slack 的[邀请](https://slack.cncf.io/)加入 CNCF Slack 的
+  [#Kubean](https://cloud-native.slack.com/messages/kubean) 频道。一旦您可以访问 CNCF Slack，您就可以加入 Kubean 频道。
+- 电子邮件: 请参阅 [MAINTAINERS.md](./MAINTAINERS.md) 查找所有维护人员的电子邮件地址。
+  随时通过电子邮件与他们联系，报告任何问题或提出问题。
 
 ## :thumbsup: 贡献者
 
@@ -128,10 +138,16 @@ We are a [Cloud Native Computing Foundation sandbox project](https://www.cncf.io
 
 The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).
 
+---
+
 <div align="center">
 <p>
 <img src="https://landscape.cncf.io/images/cncf-landscape-horizontal-color.svg" width="300"/>
 <br/><br/>
 Kubean 位列 <a href="https://landscape.cncf.io/?selected=kubean">CNCF 云原生全景图</a>
 </p>
 </div>
+
+## License
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean?ref=badge_large)