Update docs (#165)

* update readme.md/readme_en.md
TencentBlueKing · Jan 3, 2020 · 709511b · 709511b
1 parent 1c9e4e9
commit 709511b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 28 deletions.
diff --git a/docs/resource/img/bk_paas_en.png b/docs/resource/img/bk_paas_en.png
diff --git a/docs/resource/img/bk_paas_zh.png b/docs/resource/img/bk_paas_zh.png
diff --git a/README.md → readme.md b/README.md → readme.md
@@ -1,11 +1,12 @@
-# 蓝鲸智云PaaS平台（社区版）
-<img src="docs/resource/img/logo.png" width="250" hegiht="10" align=center />
+![](docs/resource/img/bk_paas_zh.png)
+---
 
-[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/Tencent/bk-PaaS/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-3.2.2-blue.svg)](https://github.com/Tencent/bk-PaaS/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/bk-PaaS/pulls) [![](https://travis-ci.com/Tencent/bk-PaaS.svg?token=ypkHQqxUR3Y3ctuD7qFS&branch=master)](https://travis-ci.com/Tencent/bk-PaaS)
+[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-PaaS/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-3.2.2-brightgreen.svg)](https://github.com/Tencent/bk-PaaS/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-PaaS/pulls) [![](https://travis-ci.com/Tencent/bk-PaaS.svg?token=ypkHQqxUR3Y3ctuD7qFS&branch=master)](https://travis-ci.com/Tencent/bk-PaaS)
 
 
+[(English Documents Available)](readme_en.md)
 
-[(English Documents Available)](README_EN.md)
+> **社区版**
 
 蓝鲸智云PaaS平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理SaaS应用。
 
@@ -40,24 +41,22 @@
 
 - [极速体验容器化部署蓝鲸智云PaaS平台](docs/wiki/container-support.md)
 
-## Install
+## Getting started
 
 - [安装部署PaaS](docs/install/ce_paas_install.md)
 - [安装部署PaaSAgent](docs/install/ce_paas_agent_install.md)
 - [替换已安装的蓝鲸社区版指引](https://docs.bk.tencent.com/bk_osed/guide.html#osed)
 
 
-## Release
+## Roadmap
 
 - [PaaS 版本日志](paas-ce/paas/release.md)
 - [PaaSAgent 版本日志](paas-ce/paasagent/release.md)
 
-## 蓝鲸开源SaaS应用列表
-
-- [标准运维](https://github.com/Tencent/bk-sops)
-
 ## Support
 
+- [wiki](https://github.com/Tencent/bk-PaaS/wiki)
+- [FAQ](https://github.com/Tencent/bk-PaaS/wiki/FAQ)
 - [白皮书](http://docs.bk.tencent.com/product_white_paper/paas/)
 - [蓝鲸论坛](https://bk.tencent.com/s-mart/community)
 - [蓝鲸 DevOps 在线视频教程](https://cloud.tencent.com/developer/edu/major-100008)
@@ -66,15 +65,20 @@
 
 <img src="docs/resource/img/bk_qq_group.png" width="250" hegiht="250" align=center />
 
-## Contributing
+## BlueKing Community
 
-关于分支/issue及PR, 请查看 [CONTRIBUTING](docs/CONTRIBUTING.md)
+- [BK-CI](https://github.com/Tencent/bk-ci)：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
+- [BK-BCS](https://github.com/Tencent/bk-bcs)：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
+- [BK-BCS-SaaS](https://github.com/Tencent/bk-bcs-saas)：蓝鲸容器管理平台SaaS基于原生Kubernetes和Mesos自研的两种模式，提供给用户高度可扩展、灵活易用的容器产品服务。
+- [BK-PaaS](https://github.com/Tencent/bk-PaaS)：蓝鲸PaaS平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理SaaS应用。
+- [BK-SOPS](https://github.com/Tencent/bk-sops)：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是蓝鲸体系中一款轻量级的调度编排类SaaS产品。
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb)：蓝鲸配置平台是一个面向资产及应用的企业级配置管理平台。
 
-[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。
+## Contributing
 
-## FAQ
+如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为蓝鲸开源社区贡献力量。关于分支/issue及PR, 请查看 [CONTRIBUTING](docs/CONTRIBUTING.md)
 
-请查看 [FAQ](https://github.com/Tencent/bk-PaaS/wiki/FAQ)
+[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。
 
 ## License
 

diff --git a/README_EN.md → readme_en.md b/README_EN.md → readme_en.md
@@ -1,8 +1,10 @@
-# The BlueKing PaaS (Community Edition)
+![](docs/resource/img/bk_paas_en.png)
+---
 
-<img src="docs/resource/img/logo.png" width="250" hegiht="10" align=center />
+[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-PaaS/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-3.0.0-brightgreen.svg)](https://github.com/Tencent/bk-PaaS/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-PaaS/pulls)
 
-[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/Tencent/bk-PaaS/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-3.0.0-blue.svg)](https://github.com/Tencent/bk-PaaS/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/bk-PaaS/pulls)
+
+> **Community Edition**
 
 The BlueKing PaaS is an open development platform that allows developers to create, develop, deploy and manage SaaS applications quickly and easily.
 
@@ -37,23 +39,22 @@ free-operation of SaaS applications
 
 - [Quick start via Docker container(In Chinese)](docs/wiki/container-support.md)
 
-## Install
+## Getting started
 
 - [Install PaaS(In Chinese)](docs/install/ce_paas_install.md)
 - [Install PaaSAgent(In Chinese)](docs/install/ce_paas_agent_install.md)
 - [Replace the installed ce version(In Chinese)](https://docs.bk.tencent.com/bk_osed/guide.html#osed)
 
-## Release
+## Roadmap
 
 - [PaaS release log(In Chinese)](paas-ce/paas/release.md)
 - [PaaSAgent release log(In Chinese)](paas-ce/paasagent/release.md)
 
-## SaaS List
-
-- [Standard OPS](https://github.com/Tencent/bk-sops)
 
 ## Support
 
+- [Wiki(In Chinese)](https://github.com/Tencent/bk-PaaS/wiki)
+- [FAQ(In Chinese)](https://github.com/Tencent/bk-PaaS/wiki/FAQ)
 - [white paper(In Chinese)](http://docs.bk.tencent.com/product_white_paper/paas/)
 - [bk forum](https://bk.tencent.com/s-mart/community)
 - [bk DevOps online video tutorial(In Chinese)](https://cloud.tencent.com/developer/edu/major-100008)
@@ -62,16 +63,21 @@ free-operation of SaaS applications
 
 <img src="docs/resource/img/bk_qq_group.png" width="250" hegiht="250" align=center />
 
-## Contributing
+## BlueKing Community
 
-For bk-PaaS branch management, issues, and pr specifications, read the [CONTRIBUTING(In Chinese)](docs/CONTRIBUTING.md)
+- [BK-CI](https://github.com/Tencent/bk-ci)：a continuous integration and continuous delivery system that can easily present your R & D process to you.
+- [BK-BCS](https://github.com/Tencent/bk-bcs)：a basic container service platform which provides orchestration and management for micro-service business.
+- [BK-BCS-SaaS](https://github.com/Tencent/bk-bcs-saas)：a SaaS provides users with highly scalable, flexible and easy-to-use container products and services.
+- [BK-PaaS](https://github.com/Tencent/bk-PaaS)：an development platform that allows developers to create, develop, deploy and manage SaaS applications easily and quickly.
+- [BK-SOPS](https://github.com/Tencent/bk-sops)：an lightweight scheduling SaaS  for task flow scheduling and execution through a visual graphical interface. 
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb)：an enterprise-level configuration management platform for assets and applications.
 
-If you are interested in contributing, check out the [CONTRIBUTING.md], also join our [Tencent OpenSource Plan](https://opensource.tencent.com/contribution).
+## Contributing
 
+If you have good ideas or suggestions, please let us know by Issues or Pull Requests and contribute to the Blue Whale Open Source Community. For bk-PaaS branch management, issues, and pr specifications, read the [CONTRIBUTING(In Chinese)](docs/CONTRIBUTING.md)
 
-## FAQ
+If you are interested in contributing, check out the [CONTRIBUTING.md], also join our [Tencent OpenSource Plan](https://opensource.tencent.com/contribution).
 
-[FAQ](https://github.com/Tencent/bk-PaaS/wiki/FAQ)
 
 ## License