该仓库归集了 CNB 插件信息,展示在插件市场,方便大家选用。
plugins/plugins.json 是所有插件的汇总,其 raw 地址可作为插件市场的数据源使用。
在管理平台将 plugins/plugins.json 的 raw 文件地址 配置为插件市场数据源。
在 plugins 目录下创建插件子目录。
比如 plugins/cnbcool/hello-world
添加插件的 Meta 信息plugin-meta.json 到子目录中,字段如下:
{
"name": "hello world",
"description": "一个简单的插件demo",
"mark": "official",
"images": "https://hub.docker.com/r/cnbcool/hello-world/tags",
"source": "https://cnb.cool/cnb/plugins/cnbcool/hello-world",
"bugs": "https://cnb.cool/cnb/plugins/cnbcool/hello-world/-/issues",
"tags": [
"demo",
"example"
],
"logo": "logo.png"
}
name: 插件名称,需要全英文,单词之间以中划线-分隔。description: 插件描述,简单介绍插件作用。tags: 标签,是一个字符串数组,用于分类。mark: 插件角标, 选填。
official: 官方维护的插件private: 特定组织、业务使用的插件images: 插件镜像地址。source: 源码地址。bugs: 问题反馈地址。logo: logo 图片相对地址,可以不填。图片最好为正方形,尺寸大于 100 x 100 即可。添加 logo README.md 等必要文件到插件 Meta 信息所在目录。
提交修改,发起 PR 等待自动检查工具通过和人工审核。
评审通过,合并后,会触发流水线将 plugins/cnbcool 下的插件信息归集到 plugins/plugins.json 中
刷新文档插件市场页面或插件详情页,插件信息会自动更新。