Skip to content

Commit aab1064

Browse files
plusiceplusicechen
andauthored
docs(manifest): 优化文档 (#28)
* docs(manifest): 优化文档 * docs: 优化文档 drone-plugins/drone-docker,需要 privileged 才能执行,删除掉 glaszig/drone-capistrano,只支持drone,删除掉 --------- Co-authored-by: plusicechen <plusicechen@tencent.com>
1 parent 60eddad commit aab1064

File tree

50 files changed

+524
-804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+524
-804
lines changed

plugins/artifactory/artifactory/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Artifactory
22

3-
发布文件或者制品到制品库插件
3+
发布文件或者制品到制品库。
44

55
## 在 Coding-CI 上使用
66

@@ -22,26 +22,26 @@ master:
2222
2323
## 参数
2424
25-
* `url`-项目url(包括scheme)
25+
* `url`-项目url(包括scheme)
2626

27-
* `username`-制品库用户名,默认为空
27+
* `username`-制品库用户名,默认为空
2828

29-
* `password`-制品库密码,默认为空
29+
* `password`-制品库密码,默认为空
3030

31-
* `pom`-用于读取项目详细信息的可选的pom.xml路径
31+
* `pom`-用于读取项目详细信息的可选的pom.xml路径
3232

33-
* `group_id`-项目组id,默认为Pom文件中的值
33+
* `group_id`-项目组id,默认为Pom文件中的值
3434

35-
* `artifact_id`-项目项目id,默认为Pom文件中的值
35+
* `artifact_id`-项目项目id,默认为Pom文件中的值
3636

37-
* `version`-制品版本,默认为Pom文件中的值
37+
* `version`-制品版本,默认为Pom文件中的值
3838

39-
* `repo_key`-目标存储库密钥
39+
* `repo_key`-目标存储库密钥
4040

41-
* `files`-要部署的文件列表
41+
* `files`-要部署的文件列表
4242

43-
* `force_upload`-如果文件已存在,则强制上传
43+
* `force_upload`-如果文件已存在,则强制上传
4444

4545
## 更多用法
4646

47-
更多用法参考:[athieriot/drone-artifactory](https://github.com/athieriot/drone-artifactory)
47+
更多用法参考:[athieriot/drone-artifactory](https://github.com/athieriot/drone-artifactory)

plugins/capistrano/capistrano/README.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

plugins/capistrano/capistrano/logo.svg

Lines changed: 0 additions & 20 deletions
This file was deleted.

plugins/capistrano/capistrano/plugin-meta.json

Lines changed: 0 additions & 10 deletions
This file was deleted.

plugins/clair/clair/README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Clair
22

3-
通过Clair扫描docker镜像插件
3+
通过 Clair 扫描 docker 镜像插件。
44

55
## 在 Coding-CI 上使用
66

@@ -22,34 +22,32 @@ master:
2222
scan_image: python:2.7
2323
```
2424
25-
## 参数
26-
2725
### 环境变量
2826
2927
DOCKER_USERNAME
30-
: 通过环境变量传递`username`
28+
: 通过环境变量传递 `username`
3129

3230
DOCKER_PASSWORD
33-
: 通过环境变量传递 `password`
31+
: 通过环境变量传递 `password`
3432

3533
CLAIR_URL
36-
: 通过环境变量传递 `url`
34+
: 通过环境变量传递 `url`
3735

3836
CLAIR_CA_CERT
39-
: 通过环境变量传递 `ca_cert`
37+
: 通过环境变量传递 `ca_cert`
4038

4139
### 参数
4240

43-
* url:Clair服务器URL
41+
* url:Clair 服务器 URL。
4442

45-
* username:Docker Registry用户名,用于下载scan_image
43+
* username:Docker Registry用户名,用于下载 `scan_image`。
4644

47-
* password:Docker Registry密码,用于下载scan_image
45+
* password:Docker Registry密码,用于下载 `scan_image`。
4846

49-
* scan_image:要扫描的docker图像。支持Docker Hub或私有仓库
47+
* scan_image:要扫描的 docker 图像。支持 Docker Hub 或私有仓库。
5048

51-
* ca_cert:用于验证https的CA证书
49+
* ca_cert:用于验证 https 的 CA 证书。
5250

5351
## 更多用法
5452

55-
更多用法参考:[jmccann/drone-clair](https://github.com/jmccann/drone-clair)
53+
更多用法参考:[jmccann/drone-clair](https://github.com/jmccann/drone-clair)

plugins/codecov/codecov/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ master:
1616
1717
## 参数
1818
19-
* `token`:设置专用存储库令牌。必修的
19+
* `token`:设置专用存储库令牌。必修的
2020

2121
* `files`:要上载的目标文件列表。可选择的
2222

2323
* `flags`:标记上载到组的覆盖率度量。可选择的
2424

25-
* `debug`:调试模式,默认为`false`
25+
* `debug`:调试模式,默认为`false`
2626

2727
## 更多用法
2828

plugins/datadog/datadog/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Datadog
22

3-
发送events和metrics到Datadog
3+
发送 events 和 metrics 到 Datadog
44

55
## 在 Coding-CI 上使用
66

@@ -17,20 +17,20 @@ master:
1717
- type: "count"
1818
name: "masci.pipelines.count"
1919
value: 1.0
20-
tags: ["project:${DRONE_REPO_NAME}", "branch:${DRONE_BRANCH}"]
20+
tags: ["project:${CODING_PROJECT_NAME}", "branch:${CODING_BRANCH}"]
2121
```
2222
2323
## 参数
2424
25-
* `api_key`:用于发送metrics和events的Datadog API密钥
25+
* `api_key`:用于发送 metrics 和 events 的 Datadog API密钥
2626

27-
* `dry_run`:当设置为`true`时,插件只计算metrics和events,而不计算向Datadog入口发送任何信息。
27+
* `dry_run`:当设置为`true`时,插件只计算 metrics 和 events,而不计算向 Datadog 入口发送任何信息
2828

29-
* `metrics`:要发送到Datadog的度量列表。
29+
* `metrics`:要发送到 Datadog 的度量列表
3030

31-
* `events`:要发送到Datadog的事件列表。事件必须具有`title``text`
31+
* `events`:要发送到 Datadog 的事件列表。事件必须具有 `title``text`
3232

33-
* `alert_type`默认为`info`
33+
* `alert_type`默认为`info`
3434

3535
## 更多用法
3636

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
# diagnostics
22

3-
用来诊断构建中问题的带cli工具的插件
3+
一个 cli 工具插件,用于诊断构建过程中出现的问题。
44

55
## 在 Coding-CI 上使用
66

7+
插件内置了一些诊断工具,可以用命令行来调用它们。
8+
9+
内置的工具:
10+
11+
- ping
12+
- traceroute
13+
- dig
14+
715
```yml
816
master:
917
push:
@@ -18,14 +26,7 @@ master:
1826
- echo "end of test"
1927
```
2028
21-
## 参数
22-
23-
已安装的工具:
24-
25-
- ping
26-
- traceroute
27-
- dig
28-
2929
## 更多用法
3030
31-
更多用法参考:[drone-plugins/drone-diagnostics](https://github.com/drone-plugins/drone-diagnostics)
31+
更多用法参考:
32+
[drone-plugins/drone-diagnostics](https://github.com/drone-plugins/drone-diagnostics)。

plugins/docker/docker/README.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

0 commit comments

Comments
 (0)