# open-demo

**Repository Path**: open4u/open-demo

## Basic Information

- **Project Name**: open-demo
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 开源演示环境的项目计划书

## 背景介绍

Web 类的开源项目通常是需要通过在线 demo 演示环境来让潜在的用户可以快速地浏览该项目的基本功能，从而可以更加形象化地评估是否可以将该项目应用到自己所在的团队或则个人项目中。对于为数众多的个人开发者，他们往往需要为此而付出许多个人精力以及经济上的投入，这一点对于暂时关注度不高的开源项目来说，是实实在在的痛点。

另外，由于这些 demo 系统处于良莠不齐的状态，对于调研开源项目的用户而言，也缺乏一个可以集中浏览、对比的平台。就目前而言，我们只能是逐个去查找和对别。

## 项目发起人

Rick，Jenkins 中文社区发起人。具有10年以上的一线的研发经历，热衷于开源技术的布道。同时，还是 CDF（持续交付基金会）的 Ambassador，以及 Jenkins 社区的中国区媒体联系人，Jenkins 中文本地化 SIG Leader。

## 组织方

Open for You 社区(https://github.com/open4u/)，以开源的形式致力于为每一位开源爱好者、开源项目贡献者提供专业的开源支持和服务。

## 项目计划

基于 [Kubeshpere](https://kubesphere.io/) 这款开源容器平台，搭建一个系统，允许开源项目的作者自行提交一个 YAML 配置文件，然后就可以动态地部署在线 demo 环境。

## 项目准入机制

为了使得该计划中所参与的开源项目的质量得以保障，符合下述条件的项目才能使用我们的平台：

* 符合中国相关的法律法规
* 开源协议，必须是 [GitHub](https://github.com/) 或 [Gitee](https://gitee.com/) 所支持的协议
* 维护频率，自申请日起，半年内有维护历史；项目创建半年以上
* 关注度，在 [GitHub](https://github.com/) 或 [Gitee](https://gitee.com/) 上有不少于50个 star
* 负责人，至少有一个人承诺一个月可以维护一次 demo 系统
* 项目类型，支持容器化部署

项目默认配额，磁盘5G、1个CPU、1G内存。如需更高的配额，需要提出邮件申请，并给出说明。

demo 系统要支持自定义域名或子域名。

## 项目约定

为了实现开源项目和赞助商的共赢局面，接受入驻的开源项目，需要接受如下的条约：

* 在 demo 页面的底部增加战略级赞助商的宣传语，例如：`Powered by Kubesphere`，并带有指向对应项目的 GitHub 地址

## 收益方分析

### 参与者

不需要自行提供运行环境的经济支出，也无需花费精力对环境进行常规的维护。通过集中式的 demo 环境演示，有助于对方的项目推广。

### 赞助方

加 logo 展示到赞助方页面，并加对应企业或则个人的基本介绍。赞助方，可以很清晰地看到，我们所接受捐赠的分配和使用记录。

战略级的赞助方，可以在所有的 demo 系统页面添加如下的文案：`Powered by Kubesphere`。需要注意的是，这里所要加的赞助商的项目必须是开源的，需要托管在 GitHub 或者 Gitee 上，而且，所添加的链接也应该是代码托管平台的地址。

### 组织方

希望能帮助国内的开源项目作者或者社区提供相应支持，建立国内的开源生态，在业界形成一定的影响力（reputation）。

关于组织形式，由 [Open for You](https://github.com/open4u/) 社区发起并主办，联合 Jenkins 中文社区、Kubesphere 社区。同时，我们也积极地寻求国内外其他社区、个人的支持。关于 Open for You 社区后续的发展规划，希望能得到国内对开源关注的企业的赞助支持，当接受捐助的金额可以注册公司后，会注册一家不以盈利为目的的公司，专门从事服务开源项目、个人、社区的业务。将公司的账务、规章制度、捐助明细完全公开。

## 目标与计划

大致分为三步走
1. 邀请部分开源项目加入，完善该平台
2. 成为国内开源项目在线演示平台的缺省选择
3. 打造国际化的平台，积极地和国外的社区合作

关于第一步的具体操作上，首先邀请5～15个开源项目加入；然后，对外公布我们的平台会试运营一个月的时间，收集更多的反馈并酌情改善；最后，接受外部项目的直接申请，通过相应的流程后接纳或者给出拒绝理由。

联合 [Kubesphere](http://github.com/kubesphere/) 社区共同发布该项目，而且也是 Jenkins 中文社区和 Kubesphere 社区合作的重点项目。

## 运维

* 确保每个开源项目都有负责人，公开联系方式（GitHub或者其他的）
* 创建 Slack、微信群等公开交流频道
* 自动检查chart仓库进行升级
* 定期清理数据

## 服务器资源

按照初步计划容纳的项目规模（15个），所需要的服务器的规模（节点的总量）至少为：

* 25G 内存
* 10 CPU
* 1 TB 硬盘
* 3M 带宽
* 一个公网 IP

为了可以确保该项目可以长久运营下去，希望至少能在初期得到2年的服务器支持，并签订相应的协议。

## 备选项目

* [Jenkins](https://github.com/jenkinsci/jenkins)
* [开源团队协作沟通](https://gitee.com/xiweicheng/tms)
* [Jenkins Custom Distribution Service](https://github.com/jenkinsci/custom-distribution-service/)