Skip to content

Commit

Permalink
docs: 蓝鲸开源项目规范 issue #324
Browse files Browse the repository at this point in the history
  • Loading branch information
irwinsun committed Dec 17, 2019
1 parent 7a656d2 commit b39fce6
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -4,7 +4,7 @@

## 代码协议

[MIT LICENSE](./LICENSE) 为 BK-CI 的开源协议,任何人贡献的代码也会受此协议保护,贡献代码前也请明确是否可以接受该协议。
[MIT LICENSE](LICENSE.txt) 为 BK-CI 的开源协议,任何人贡献的代码也会受此协议保护,贡献代码前也请明确是否可以接受该协议。

## 设计文档

Expand Down
File renamed without changes.
43 changes: 23 additions & 20 deletions README.md
@@ -1,6 +1,6 @@
![LOGO](docs/resource/img/bkci_cn.png)
---
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-ci/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-0.0.1-brightgreen.svg)](https://github.com/Tencent/bk-ci/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-ci/pulls)
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-ci/blob/master/LICENSE) [![Release Version](https://img.shields.io/badge/release-0.0.1-brightgreen.svg)](https://github.com/Tencent/bk-ci/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-ci/pulls)[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/devopsee/p-f4cefb12bae448e883a3b6b9ec5f6fac/badge?X-DEVOPS-PROJECT-ID=devopsee)](http://api.devops.qq.com/process/api-html/user/builds/projects/devopsee/pipelines/p-f4cefb12bae448e883a3b6b9ec5f6fac/latestFinished?X-DEVOPS-PROJECT-ID=devopsee)

> **重要提示**: `master` 分支在开发过程中可能处于 *不稳定或者不可用状态*
请通过[releases](https://github.com/tencent/bk-ci/releases) 而非 `master` 去获取稳定的二进制文件。
Expand Down Expand Up @@ -30,37 +30,40 @@
- [设计理念](docs/overview/design.md)

## Features
| 特性 | 介绍 |
| ------ | ------ |
| **持续集成和持续交付** | 由于框架的可扩展性,蓝盾既可以用作简单的CI场景,也可以成为企业内所有项目的持续交付中心 |
| **所见即所得** | 蓝盾提供了灵活的可视化编排流水线,动动指尖,将研发流程描述与此 |
| **架构平行可扩展** | 灵活的架构设计可以随意横向扩容,满足企业大规模使用 |
| **分布式** | 蓝盾可以便捷的管控多台构建机,助你更快的跨多平台构建、测试和部署 |
| **流水线插件** | 蓝盾拥有完善的插件开发体系,其具备了低门槛、灵活可扩展等特性 |
| **流水线模板** | 流水线模板将是企业内部推行研发规范的一大助力 |

## Getting started
- 持续集成和持续交付: 由于框架的可扩展性,蓝盾既可以用作简单的CI场景,也可以成为企业内所有项目的持续交付中心
- 所见即所得: 蓝盾提供了灵活的可视化编排流水线,动动指尖,将研发流程描述与此
- 架构平行可扩展: 灵活的架构设计可以随意横向扩容,满足企业大规模使用
- 分布式: 蓝盾可以便捷的管控多台构建机,助你更快的跨多平台构建、测试和部署
- 流水线插件: 蓝盾拥有完善的插件开发体系,其具备了低门槛、灵活可扩展等特性
- 流水线模板: 流水线模板将是企业内部推行研发规范的一大助力

## Experience
- [v1版Docker体验镜像下载](https://hub.docker.com/r/blueking/bk-ci)

## Getting started
- [下载与编译](docs/overview/source_compile.md)
- [一分钟安装部署](docs/overview/installation.md)

## Support
1. 阅读 [wiki](https://github.com/Tencent/bk-ci/wiki) 或者寻求帮助
2. 常见 [FAQ](https://github.com/Tencent/bk-ci/wiki/FAQ)
3. 了解蓝鲸整体的社区生态请加入蓝鲸社区版交流QQ群,:495299374
3. 了解蓝鲸整体的社区生态请加入[蓝鲸社区版交流1群](https://jq.qq.com/?_wv=1027&k=5zk8F7G):495299374

# They are using BK-CI
> ![Using](docs/resource/img/using.png)
## BK Community
- [BCS](https://github.com/Tencent/bk-bcs):蓝鲸容器管理平台是以容器技术为基础,为微服务业务提供编排管理的基础服务平台。
- [CMDB](https://github.com/Tencent/bk-cmdb):蓝鲸配置平台(蓝鲸CMDB)是一个面向资产及应用的企业级配置管理平台。
- [PaaS](https://github.com/Tencent/bk-PaaS):蓝鲸PaaS平台是一个开放式的开发平台,让开发者可以方便快捷地创建、开发、部署和管理SaaS应用。
- [SOPS](https://github.com/Tencent/bk-sops):标准运维(SOPS)是通过可视化的图形界面进行任务流程编排和执行的系统,是蓝鲸体系中一款轻量级的调度编排类SaaS产品。
## BlueKing Community
- [BK-BCS](https://github.com/Tencent/bk-bcs):蓝鲸容器管理平台是以容器技术为基础,为微服务业务提供编排管理的基础服务平台。
- [BK-CMDB](https://github.com/Tencent/bk-cmdb):蓝鲸配置平台(蓝鲸CMDB)是一个面向资产及应用的企业级配置管理平台。
- [BK-PaaS](https://github.com/Tencent/bk-PaaS):蓝鲸PaaS平台是一个开放式的开发平台,让开发者可以方便快捷地创建、开发、部署和管理SaaS应用。
- [BK-SOPS](https://github.com/Tencent/bk-sops):蓝鲸标准运维(SOPS)是通过可视化的图形界面进行任务流程编排和执行的系统,是蓝鲸体系中一款轻量级的调度编排类SaaS产品。

## Contributing to BK-CI
- 关于 bk-ci 分支管理、issue 以及 pr 规范,请阅读 [Contributing](CONTRIBUTING.md)
- [腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献,期待你的加入

## Other
### They are using BK-CI
> ![Using](docs/resource/img/using.png)

## License
BK-CI 是基于 MIT 协议, 详细请参考 [LICENSE](LICENSE)
BK-CI 是基于 MIT 协议, 详细请参考 [LICENSE](LICENSE.txt)

0 comments on commit b39fce6

Please sign in to comment.