mirror of
https://github.com/yunionio/cloudpods.git
synced 2026-10-30 18:23:35 +08:00
Merge pull request #11328 from swordqiu/hotfix/qj-improve-documentation-20200604
fix: improve documentation
This commit is contained in:
Zexi Li
+50
-2
@@ -1,3 +1,51 @@
|
||||
# Contributing
|
||||
# Contribution Guide
|
||||
|
||||
[English](CONTRIBUTING.md) | [中文](CONTRIBUTING_zh.md)
|
||||
|
||||
You can help to make Cloudpods better! There are many things you can do:
|
||||
|
||||
## Help others to know Cloudpods
|
||||
|
||||
First of all, the easiest way to contribute to Cloudpods is to let more people known Cloudpods. To share your experience of Cloudpods. Hopefully Cloudpods may help resolve the issues in their daily jobs.
|
||||
|
||||
## Report Bugs
|
||||
|
||||
Cloudpos is an infrastructure management tool. Even though it has been thourougly tested and codes have been peer reviwed before merge, due to various reasons, you may still encounter bugs when using Cloudpods. This is frustrating. However, please do not hesitate to submit a issue at Github. The issue may help developers to improve the codes and make Cloudpods more and more robust. Meanwhile, the answer to the issues may also help others who meet the same bugs.
|
||||
|
||||
## Answer issues
|
||||
|
||||
You may answer issues at Github and help those who encounter issues when using Cloudpods. Sometimes, the issues are not due to bugs in codes but simplely because of misconfigurations, environment or misunderstandings.
|
||||
|
||||
## Contribute codes
|
||||
|
||||
You are welcome to contribute codes to Cloudpods. Please refers to [CONTRIBUTING](https://docs.yunion.io/en/docs/contribute/contrib/) for more details on how to contribute codes to Cloudpods.
|
||||
|
||||
### Fix Issues
|
||||
|
||||
You may help solve bugs by submiting patches.
|
||||
|
||||
|
||||
### New Features
|
||||
|
||||
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
|
||||
|
||||
## Documentation
|
||||
|
||||
You may help improve documentations of Cloudpds by directly make pull request to documentations. Once the Pull Request is accepted and merged, the documentations will be updated immediately.
|
||||
|
||||
## Translation
|
||||
|
||||
You may help translate the UI texts or documents of Cloudpds to other languages. Currently, we support Simplified Chinese and English.
|
||||
|
||||
## Write articles
|
||||
|
||||
You are also welcome to write articles about Cloudpods and sharing your experience with others. The content of the articles may include the following but not be limited to:
|
||||
* Your user experiences with Cloudpods
|
||||
* Your opinion about the direction and area of Cloudpods
|
||||
* Comparison with other cloud platforms
|
||||
* Benchmarks
|
||||
|
||||
|
||||
Please refer to the document "[Development Contribution](https://docs.yunion.io/en/docs/contribute/)".
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
# 贡献指南
|
||||
|
||||
[English](CONTRIBUTING.md) | [中文](CONTRIBUTING_zh.md)
|
||||
|
||||
你有很多事情可以做，使得Cloudpods变得更完善，
|
||||
|
||||
## 让别人知道Cloudpods
|
||||
|
||||
First of all, the easiest way to contribute to Cloudpods is to let more people known Cloudpods. To share your experience of Cloudpods. Hopefully Cloudpods may help resolve the issues in their daily jobs.
|
||||
|
||||
## 报告BUG
|
||||
|
||||
Cloudpos is an infrastructure management tool. Even though it has been thourougly tested and codes have been peer reviwed before merge, due to various reasons, you may still encounter bugs when using Cloudpods. This is frustrating. However, please do not hesitate to submit a issue at Github. The issue may help developers to improve the codes and make Cloudpods more and more robust. Meanwhile, the answer to the issues may also help others who meet the same bugs.
|
||||
|
||||
## 回答问题
|
||||
|
||||
You may answer issues at Github and help those who encounter issues when using Cloudpods. Sometimes, the issues are not due to bugs in codes but simplely because of misconfigurations, environment or misunderstandings.
|
||||
|
||||
## 贡献代码
|
||||
|
||||
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING](https://docs.yunion.io/zh/docs/contribute/contrib/).
|
||||
|
||||
### 修复BUG
|
||||
|
||||
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
|
||||
|
||||
## 文档化
|
||||
|
||||
You may help improve documentations of Cloudpds by directly make pull request to documentations. Once the Pull Request is accepted and merged, the documentations will be updated immediately.
|
||||
|
||||
## 翻译
|
||||
|
||||
You may help translate the UI texts or documents of Cloudpds to other languages. Currently, we support Simplified Chinese and English.
|
||||
|
||||
## 写文章
|
||||
|
||||
You are also welcome to write articles about Cloudpods and sharing your experience with others. The content of the articles may include the following but not be limited to:
|
||||
* Your user experiences with Cloudpods
|
||||
* Your opinion about the direction and area of Cloudpods
|
||||
* Comparison with other cloud platforms
|
||||
* Benchmarks
|
||||
|
||||
+4
-4
@@ -6,7 +6,7 @@
|
||||
|
||||
## Cloudpods是什么?
|
||||
|
||||
Cloudpods是一个开源的Golang实现的云原生融合多云/混合云的云平台。Cloudpods可以理解为pod(豆荚) of clouds。Cloupods可以管理多个云平台和云账号。并且，Cloudpods隐藏了这些平台和账号之间的云资源的数据模型和API的差异，对外暴露了一套统一的API。从而大大降低了访问多云的复杂度，提升了管理多云资源的效率。
|
||||
Cloudpods是一个开源的Golang实现的云原生融合多云/混合云的云平台。Cloupods可以管理多个云平台和云账号。并且，Cloudpods隐藏了这些平台和账号之间的云资源的数据模型和API的差异，对外暴露了一套统一的API。从而大大降低了访问多云的复杂度，提升了管理多云的效率。
|
||||
|
||||
## 功能
|
||||
|
||||
@@ -21,7 +21,7 @@ Cloudpods提供了如下的功能：
|
||||
* 一套完整的多租户认证和访问控制体系
|
||||
* 自动将镜像转换为不同云平台需要的格式的多云镜像服务
|
||||
|
||||
## 安装
|
||||
## 快速开始
|
||||
|
||||
我们可以通过以下简单三步将Cloudpods安装在一台至少8GiB内存和100GB硬盘的Linux主机上（假设该主机的IP为 *10.168.26.216*）：
|
||||
|
||||
@@ -73,14 +73,14 @@ $ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py 10.168
|
||||
- [Swagger API文档](https://docs.yunion.cn/api/)
|
||||
|
||||
|
||||
## 开发计划
|
||||
## 规划
|
||||
|
||||
请访问[Cloudpods Roadmap](https://docs.yunion.io/zh/docs/roadmap/).
|
||||
|
||||
|
||||
## 贡献
|
||||
|
||||
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING](https://docs.yunion.io/zh/docs/contribute/contrib/) 。
|
||||
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING](./CONTRIBUTING_zh.md)。
|
||||
|
||||
|
||||
## License
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
## What is Cloudpods?
|
||||
|
||||
Cloudpods is an cloud-native open source unified multicloud/hybrid-cloud cloud platform developed with Golang. As the name implies, Cloudpods manages the resources from many cloud accounts across many cloud providers. Further, it hides the differences of underlying cloud providers and exposes one set of APIs that allow programatically interacting with the resources across many clouds.
|
||||
Cloudpods is an cloud-native open source unified multicloud/hybrid-cloud cloud platform developed with Golang. Cloudpods manages the resources from many cloud accounts across many cloud providers. Further, it hides the differences of underlying cloud providers and exposes one set of APIs that allow programatically interacting with many clouds.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -21,9 +21,9 @@ Cloudpods is an cloud-native open source unified multicloud/hybrid-cloud cloud p
|
||||
* A complete multi-tenancy RBAC-enabled IAM (identity and access management) system
|
||||
* Multi-cloud image management system that automates image conversion between different cloud providers
|
||||
|
||||
## Installation
|
||||
## Quick start
|
||||
|
||||
You may install Cloudpods into a Linux box with at least 8GiB RAM and 100GB storage by following three simple steps (assuming that you install Cloudpods on a Linux box with IP *10.168.26.216*):
|
||||
You may install Cloudpods in a Linux box with at least 8GiB RAM and 100GB storage by following three simple steps (assuming that you install Cloudpods on a Linux box with IP *10.168.26.216*):
|
||||
|
||||
### 1. Prepare passwordless SSH login
|
||||
|
||||
@@ -78,7 +78,7 @@ See [Cloudpods Roadmap](https://docs.yunion.io/en/docs/roadmap/) for details.
|
||||
|
||||
## Contribution
|
||||
|
||||
You are welcome to contribute to the project. Please refer to [CONTRIBUTING](https://docs.yunion.io/en/docs/contribute/contrib/) for guidelines.
|
||||
You are welcome to contribute to the project. Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for guidelines.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user