From 4b599f33be52a0aad25299de4540a2cd30bab205 Mon Sep 17 00:00:00 2001 From: Zexi Li Date: Tue, 9 Jan 2024 12:37:36 +0800 Subject: [PATCH] fix(README): simplify content and remove deadlinks --- CONTRIBUTING.md | 6 +- CONTRIBUTING_zh.md | 6 +- README-CN.md | 201 ++------------------------------------------- README.md | 201 +-------------------------------------------- 4 files changed, 15 insertions(+), 399 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a966f625e4..0fbaf2713c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ You may answer issues at Github and help those who encounter issues when using C ## Contribute codes -You are welcome to contribute codes to Cloudpods. Please refers to [CONTRIBUTING](https://www.cloudpods.org/en/docs/contribute/contrib/) for more details on how to contribute codes to Cloudpods. +You are welcome to contribute codes to Cloudpods. Please refers to [CONTRIBUTING](https://www.cloudpods.org/en/docs/development/contrib/) for more details on how to contribute codes to Cloudpods. ### Fix Issues @@ -29,8 +29,8 @@ You may help solve bugs by submiting patches. You may help improve the codes of Cloudpods, including: -* Develop new features for Cloudpods -* Recode some part of Cloudpods so as to make the code easier to be understood, or less error-prone, or more efficient +* Develop new [features for Cloudpods](https://github.com/yunionio/cloudpods/issues?q=is%3Aopen+is%3Aissue+label%3Afeature). +* Recode some part of Cloudpods so as to make the code easier to be understood, or less error-prone, or more efficient. ## Documentation diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md index 82482bdada..d3709474bf 100644 --- a/CONTRIBUTING_zh.md +++ b/CONTRIBUTING_zh.md @@ -18,7 +18,7 @@ Cloudpods是一款开源的基础设施管理工具软件，运行场景复杂 ## 贡献代码 -我们非常欢迎和感谢开发者向项目提交代码PR，流程细节请查看 [CONTRIBUTING](https://www.cloudpods.org/zh/docs/development/contrib/). +我们非常欢迎和感谢开发者向项目提交代码PR，流程细节请查看 [CONTRIBUTING](https://www.cloudpods.org/docs/development/contrib/). ### 修复BUG @@ -27,8 +27,8 @@ Cloudpods是一款开源的基础设施管理工具软件，运行场景复杂 ### 开发新的功能特性 不仅仅是修复BUG，您也可以通过提交代码以改进Cloudpods，包括但不限于： -* 开发新的功能特性，您可以在[Cloudpods Roadmap](https://www.cloudpods.org/zh/docs/roadmap/)找到Cloudpods的功能规划 -* 重构代码，使得代码更加简洁易读，更加低健壮，或者执行起来更加高效 +* 开发新的功能特性，您可以在[feature issues](https://github.com/yunionio/cloudpods/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)查找需要的功能。 +* 重构代码，使得代码更加简洁易读，更加低健壮，或者执行起来更加高效。 ## 文档 diff --git a/README-CN.md b/README-CN.md index 7b6c5f01af..9c8482a599 100644 --- a/README-CN.md +++ b/README-CN.md @@ -6,7 +6,7 @@ ## Cloudpods是什么? -Cloudpods +Cloudpods Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的云平台，也就是一个“云上之云”。Cloudpods不仅可以管理本地的虚拟机和物理机资源，还可以管理多个云平台和云账号。Cloudpods隐藏了这些异构基础设施资源的数据模型和API的差异，对外暴露了一套统一的API，允许用户就像用一个云一样地访问多云。从而大大降低了访问多云的复杂度，提升了管理多云的效率。 @@ -21,186 +21,7 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的 ## 功能 -### 概览 & UI 展示 - -![](https://www.cloudpods.org/zh/docs/introduce/images/interface1.gif) - -
- 管理多云资源的功能，可以管理大多数的主流云，包括私有云，例如OpenStack，以及公有云，例如AWS，Azure，GCP，阿里云，华为云和腾讯云等 - -
- -
- - 一个可以管理海量KVM虚拟机的轻量级私有云 - - -
- -
- - 一个能进行物理机全生命周期管理的裸机云 - - -
- -
- 一套完整的多租户认证和访问控制体系 - -
- -
- - 实现了VMware vSphere虚拟化集群的自助服务和自动化 - - -
- - -
- - 允许以统一的联邦身份访问各个云平台的原生控制台的SSO - - -
- -
- - 一套功能丰富、统一一致的RESTAPI和模型访问以上的云资源和功能 - -
- -
- - 自动将镜像转换为不同云平台需要的格式的多云镜像服务 - -
- +请访问[产品介绍](https://www.cloudpods.org/docs/introduction/)页面了解详细信息。 ### 支持的云平台 @@ -258,23 +79,11 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的 ## 联系我们 -您可以通过如下方式联系我们： - -* 企业级支持: [服务订阅](https://www.yunion.cn/subscription/index.html) - -* 微信: 请扫描如下二维码联系我们 - -WeChat QRCode - -* 哔哩哔哩: [Cloudpods](https://space.bilibili.com/3493131737631540/) +请访问[联系我们](https://www.cloudpods.org/docs/contact/)。 ## 版本历史 -请访问[Cloudpods Changelog](https://www.cloudpods.org/zh/docs/changelog/). - -## 开发规划 - -请访问[Cloudpods Roadmap](https://www.cloudpods.org/zh/docs/roadmap/). +请访问[Cloudpods Changelog](https://www.cloudpods.org/zh/docs/changelog/)。 ## 贡献 @@ -282,4 +91,4 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的 ## License -Apache license 2.0，详情请看 [LICENSE](./LICENSE)。 +Apache license 2.0，详情请看 [LICENSE](./LICENSE)。 \ No newline at end of file diff --git a/README.md b/README.md index df36057575..b95ea22860 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## What is Cloudpods? -Cloudpods +Cloudpods Cloudpods is a cloud-native open source unified multi/hybrid-cloud platform developed with Golang, i.e. Cloudpods is *a cloud on clouds*. Cloudpods is able to manage not only on-premise KVM/baremetals, but also resources from many cloud accounts across many cloud providers. It hides the differences of underlying cloud providers and exposes one set of APIs that allow programatically interacting with these many clouds. @@ -23,188 +23,7 @@ Cloudpods is a cloud-native open source unified multi/hybrid-cloud platform deve ## Features -### Summary & UI - -![](https://www.cloudpods.org/zh/docs/introduce/images/interface1.gif) - -
- - Multi-cloud management that is able to manage a wide range of cloud providers, including private cloud, such as OpenStack, and public clouds, such as AWS, Azure, Google Cloud, Alibaba Cloud, Tencent Cloud, Huawei Cloud, etc. - - -
- -
- - A light-weight private cloud that manages KVM hypervisor in scale - - -
- -
- - A BareMetal cloud that automates the full life-cycle management of baremetal physical machines - - -
- -
- - A complete multi-tenancy RBAC-enabled IAM (identity and access management) system - - -
- -
- - VMware vSphere management that enables self-service and automation - - -
- - -
- - Cloud SSO that allows accessing native webconsole of cloud providers with unified federated identities - - -
- -
- - One set of feature-rich APIs to access a wide range of resources from cloud providers above with consistent models and APIs - -
- -
- - Multi-cloud image management system that automates image conversion between different cloud providers - -
+See [Introduction](https://www.cloudpods.org/docs/introduction/) for details. ### Supported cloud providers @@ -263,28 +82,16 @@ Please check this [issue](https://github.com/yunionio/cloudpods/issues/11427) fo ## Contact -You may contact us by: - -* Enterprise Support: [Subscription](https://www.yunion.cn/subscription/index.html) - -* WeChat: please scan the following QRCode to contact us - -WeChat QRCode - -* Bilibili: [Cloudpods](https://space.bilibili.com/3493131737631540/) +See [Contact Us](https://www.cloudpods.org/en/docs/contact/) for details. ## Changelog See [Cloudpods Changelog](https://www.cloudpods.org/en/docs/changelog/) for details. -## Roadmap - -See [Cloudpods Roadmap](https://www.cloudpods.org/en/docs/roadmap/) for details. - ## Contribution You are welcome to do any kind of contribution to the project. Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for guidelines. ## License -Apache License 2.0. See [LICENSE](./LICENSE). +Apache License 2.0. See [LICENSE](./LICENSE). \ No newline at end of file