fix: code conflict

Signed-off-by: Meng JiaFeng <[email protected]>

Author: steinliber

docs/plugins/argocdapp.md

@@ -9,7 +9,6 @@ This plugin creates an [Argo CD Application](https://argo-cd.readthedocs.io/en/s
   Or you can use both plugins(argocd+argocdapp) at the same time.
   See [GitOps Toolchain](../use-cases/gitops.md) for more info.
 - Currently, only the Helm chart is supported when creating the Argo CD application.
-- Modify the file accordingly. Especially remember to modify `ARGOCD_TOOL_NAME`.
 
 ## Usage
 
@@ -21,6 +20,35 @@ For more information on the main config, the tool file and the var file of DevSt
 --8<-- "argocdapp.yaml"
 ```
 
+### Automatically Create Helm Configuration
+
+This plugin can push helm configuration automatically when your `source.path` helm config does not exist so that you can use this plugin with helm configured already. For example:
+
+```yaml
+---
+tools:
+- name: go-webapp-argocd-deploy
+  plugin: argocdapp
+  dependsOn: ["repo-scaffolding.golang-github"]
+  options:
+    app:
+      name: hello
+      namespace: argocd
+    destination:
+      server: https://kubernetes.default.svc
+      namespace: default
+    source:
+      valuefile: values.yaml
+      path: charts/go-hello-http
+      repoURL: https://github.com/devstream-io/testrepo.git
+    imageRepo:
+      url: http://test.barbor.com/library
+      user: test_owner
+      tag: "1.0.0"
+```
+
+This config will push the default [helm config](https://github.com/devstream-io/dtm-pipeline-templates/tree/main/argocdapp/helm)](https://github.com/devstream-io/dtm-pipeline-templates/tree/main/argocdapp/helm) to repo [testrepo](https://github.com/devstream-io/testrepo.git), and the generated config will use the image `http://test.barbor.com/library/test_owner/hello:1.0.0` as the initial image for Helm.
+
 ## Use Together with the `repo-scaffolding` Plugin
 
 This plugin can be used together with the `repo-scaffolding` plugin (see document [here](./repo-scaffolding.md).)
@@ -72,32 +100,3 @@ In the example above:
 - We used `repo-scaffolding.golang-github`'s output as input for the `github-actions` plugin.
 
 Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.PLUGIN.outputs.var}}` is the syntax for using an output.
-
-## Automatically Create Helm Configuration
-
-This plugin can push helm configuration automatically when your source.path helm config not exist, so you can use this plugin with helm configured alreay. For example:
-
-```yaml
----
-tools:
-- name: go-webapp-argocd-deploy
-  plugin: argocdapp
-  dependsOn: ["repo-scaffolding.golang-github"]
-  options:
-    app:
-      name: hello
-      namespace: argocd
-    destination:
-      server: https://kubernetes.default.svc
-      namespace: default
-    source:
-      valuefile: values.yaml
-      path: charts/go-hello-http
-      repoURL: ${{repo-scaffolding.golang-github.outputs.repoURL}}
-    imageRepo:
-      url: http://test.barbor.com/library
-      user: test_owner
-      tag: "1.0.0"
-```
-
-This config will push default helm config to repo `${{repo-scaffolding.golang-github.outputs.repoURL}}`, and the generated config will use image `http://test.barbor.com/library/test_owner/hello:1.0.0` as inital image for helm.

docs/plugins/argocdapp.zh.md

@@ -1,3 +1,45 @@
 # argocdapp 插件
 
-todo
+该插件会创建一个在 Kubernetes 上 [Argo CD Application](https://argo-cd.readthedocs.io/en/stable/core_concepts/) 的自定义资源。
+
+**注意:**
+
+- 在使用该插件前需要先安装 Argocd CD。你可以使用 [helm-installer 插件](./helm-installer/argocd.md) 来安装它。
+- 目前该插件只支持 Helm chart 的配置方式。
+
+## 用例
+
+以下内容是该插件的示例配置文件。
+
+```yaml
+--8<-- "argocdapp.yaml"
+```
+
+### 自动创建 Helm 配置
+
+如果你不想要自己创建 Helm 配置，该插件支持把 Devstream 提供的默认 Helm 配置上传到 `source.path` 的配置路径上，这样你就可以直接使用该插件。配置示例如下：
+
+```yaml
+---
+tools:
+- name: go-webapp-argocd-deploy
+  plugin: argocdapp
+  dependsOn: ["repo-scaffolding.golang-github"]
+  options:
+    app:
+      name: hello
+      namespace: argocd
+    destination:
+      server: https://kubernetes.default.svc
+      namespace: default
+    source:
+      valuefile: values.yaml
+      path: charts/go-hello-http
+      repoURL: https://github.com/devstream-io/testrepo.git
+    imageRepo:
+      url: http://test.barbor.com/library
+      user: test_owner
+      tag: "1.0.0"
+```
+
+这个示例配置将会把 [Helm 配置](https://github.com/devstream-io/dtm-pipeline-templates/tree/main/argocdapp/helm) 上传到 [testrepo](https://github.com/devstream-io/testrepo.git) 仓库中，生成的 Helm 配置会使用 `http://test.barbor.com/library/test_owner/hello:1.0.0` 作为 Helm 应用的启动镜像。

docs/plugins/ci-generic.md

@@ -1,6 +1,6 @@
 # ci-generic Plugin
 
-This plugin installs ci script in GitLib/GitHub repo from local or remote url.
+This plugin installs `CI` script in `GitLib`/`GitHub` repo from a local or remote url.
 
 ## Usage
 
@@ -12,31 +12,16 @@ For more information on the main config, the tool file and the var file of DevSt
 --8<-- "ci-generic.yaml"
 ```
 
-### Field Configs
-
-| key                    | description                                                                                                      |
-| ----                   | ----                                                                                                             |
-| ci.localPath           | If your ci file is local, you can set the this field to the ci file location, which can be a directory or a file |
-| ci.remoteURL           | If your ci file is remote, you can set this field to url address                                                 |
-| ci.type                | ci type, support gitlab, github, jenkins for now                                                                 |
-| projectRepo.owner      | destination repo owner                                                                                           |
-| projectRepo.org        | destination repo org                                                                                             |
-| projectRepo.name       | destination repo name                                                                                            |
-| projectRepo.branch     | destination repo branch                                                                                          |
-| projectRepo.scmType    | destination repo type, support github/gitlab for now                                                             |
-| projectRepo.baseURL    | if you use self-build gitlab, you can set this field to gitlab address                                           |
-| projectRepo.visibility | if you use gitlab, you can set this field for repo permission                                                    |
-
 **Notes:**
 
+- `projectRepo` config option represents codebase location; for more info, you can refer to [SCM Config](./scm-option.md).
 - `ci.localPath` and `ci.remoteURL` can't be empty at the same time.
-- if you set both `ci.localPath` and `ci.remoteURL`, `ci.localPath` will be used.
-- if your `projectRepo.scmType` is `gitlab`, the `ci.type` is not allowed to be `github`.
-- if your `projectRepo.scmType` is `github`, the `ci.type` is not allowed to be `gitlab`.
+- if your `projectRepo.scmType` is `gitlab`, the `ci.type` is not allowed to be `github-actions`.
+- if your `projectRepo.scmType` is `github`, the `ci.type` is not allowed to be `gitlab-ci`.
 
-### Example
+## Example
 
-#### Local WorkFlows With Github
+### Local WorkFlows With Github
 
 ```yaml
 tools:
@@ -56,7 +41,7 @@ tools:
 
 This config will put local workflows directory to GitHub repo's .github/workflows directory.
 
-#### Remote Jenkinsfile With Gitlab
+### Remote Jenkinsfile With Gitlab
 
 ```yaml
 tools:
@@ -75,4 +60,4 @@ tools:
       baseURL: http://127.0.0.1:30000
 ```
 
-This config will put file from [remote](https://raw.githubusercontent.com/DeekshithSN/Jenkinsfile/inputTest/Jenkinsfile)  to GitLab repo.
+This config will put files from [remote](https://raw.githubusercontent.com/DeekshithSN/Jenkinsfile/inputTest/Jenkinsfile)](https://raw.githubusercontent.com/DeekshithSN/Jenkinsfile/inputTest/Jenkinsfile)  to GitLab repo.

docs/plugins/ci-generic.zh.md

@@ -2,7 +2,7 @@
 
 这个插件可以基于本地或者远程的文件在 GitLab/GitHub 安装 CI 配置
 
-## 使用
+## 用例
 
 下面的配置文件展示的是"tool file"的内容。
 
@@ -12,29 +12,16 @@
 --8<-- "ci-generic.yaml"
 ```
 
-### 字段配置
-
-| key                    | description                                                                                                      |
-| ----                   | ----                                                                                                             |
-| ci.configLocation      | If your ci file is local or remote, you can set the this field to get ci file                                    |
-| ci.configContents      | If you want to config ci in devstream, you can config configContents directly                                    |
-| ci.type                | ci type, support gitlab, github, jenkins for now                                                                 |
-| projectRepo.owner      | destination repo owner                                                                                           |
-| projectRepo.org        | destination repo org                                                                                             |
-| projectRepo.name       | destination repo name                                                                                            |
-| projectRepo.branch     | destination repo branch                                                                                          |
-| projectRepo.scmType    | destination repo type, support github/gitlab for now                                                             |
-| projectRepo.baseURL    | if you use self-build gitlab, you can set this field to gitlab address                                           |
-| projectRepo.visibility | if you use gitlab, you can set this field for repo permission                                                    |
-
 **注意事项：**
 
+- `projectRepo` 配置字段用于表示代码仓库的配置信息，具体配置可查看[SCM配置项](./scm-option.zh.md)
 - `ci.configContents` 和 `ci.configLocation` 不能同时为空。
-- 如果你同时设置了 `ci.configLocation` 和 `ci.configContents`，`ci.configContents` 将会被优先使用。
+- 如果你配置了 `projectRepo.scmType` 为 `github`，那 `ci.type` 就不能是 `gitlab-ci`。
+- 如果你配置了 `projectRepo.scmType` 为 `gitlab`，那 `ci.type` 就不能是 `github-actions`。
 
-### 示例
+## 示例
 
-#### 使用本地的 Workflows 目录
+### 使用本地的 Workflows 目录
 
 ```yaml
 tools:
@@ -54,7 +41,7 @@ tools:
 
 这个配置将会把本地当前运行环境下的 workflows 目录放置于 GitHub 的 `.github/workflows` 目录。
 
-#### 使用 HTTP 获取远程的CI文件
+### 使用 HTTP 获取远程的CI文件
 
 ```yaml
 tools:
@@ -75,7 +62,7 @@ tools:
 
 这个配置将会把[URL](https://raw.githubusercontent.com/DeekshithSN/Jenkinsfile/inputTest/Jenkinsfile) 中的 Jenkinsfile 文件置于 GitLab 的仓库。
 
-#### 使用Github仓库中的CI文件
+### 使用Github仓库中的CI文件
 ```yaml
 tools:
 - name: ci-generic
@@ -95,7 +82,7 @@ tools:
 
 这个配置将会搜索[devstream 仓库](https://github.com/devstream-io/devstream)下的staging/dtm-jenkins-pipeline-example/general 目录，获取到目录下的 Jenkinsfile，置于 gitlab 仓库内。
 
-#### 在Devstream中直接配置CI文件
+### 在Devstream中直接配置CI文件
 
 ```yaml
 tools:

docs/plugins/github-actions.md

@@ -1,9 +1,14 @@
 # github-actions plugin
 
-TODO(dtm): Add your document here.
+This plugin is used to create `Github Workflows` in your project.
 
 ## Usage
 
 ``` yaml
 --8<-- "github-actions.yaml"
 ```
+
+**Notes:**
+
+- `scm` config option represents codebase location; for more info, you can refer to [SCM Config](./scm-option.md).
+- The `pipeline` config option controls `CI` stages; you can refer to [Pipeline Config](./pipeline.md) for more info.

docs/plugins/github-actions.zh.md

@@ -1,21 +1,16 @@
 # github-actions 插件
 
-_该插件用于在项目中创建 Github Action Workflows_
+_该插件用于在项目中创建 Github Action Workflows。_
 
 ## 用例
 
-_该插件运行依赖以下环境变量：_
-
-- GITHUB_TOKEN
-
-请在使用插件前配置该环境变量。如果你不知道如何创建这个 TOKEN，可以查看以下文档：
-
-- [创建个人访问 token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
-
 下面的内容是一个示例配置文件用于创建 Github Workflows：
 
 ``` yaml
 --8<-- "github-actions.yaml"
 ```
 
-该插件的 `pipeline` 选项具体配置可查询[pipline配置项](pipeline.zh.md)。
+**注意:**
+
+- `scm` 配置字段用于表示代码仓库的配置信息，具体配置可查看[SCM配置项](./scm-option.zh.md)。
+- `pipeline` 选项项用于控制 `CI` 流程中的各个阶段，具体配置可查看文档[pipline配置项](pipeline.zh.md)。

docs/plugins/gitlab-ci.md

@@ -2,28 +2,21 @@
 
 This plugin creates GitLab CI workflow.
 
-It downloads a template of your choice, render it with provided parameters, and creates a GitLab CI file to your repo.
+It downloads a template of your choice, renders it with provided parameters, and creates a GitLab CI file for your repo.
 
 ## Usage
 
-_This plugin depends on an environment variable "GITLAB_TOKEN", which is your GitLab personal access token._
-
-TL;DR: if you are using gitlab.com (instead of a self-hosted GitLab), [click here](https://gitlab.com/-/profile/personal_access_tokens?name=DevStream+Access+token&scopes=api) to create a token for DevStream (the scope contains API only.)
-
-If you are using self-hosted GitLab, refer to the [official doc here](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) for more info.
-
-_Note: when creating the token, make sure you select "API" in the "scopes" section, as DevStream uses GitLab API to add CI workflow files._
-
 The following content is an example of the "tool file".
 
-For more information on the main config, the tool file and the var file of DevStream, see [Core Concepts Overview](../core-concepts/overview.md) and [DevStream Configuration](../core-concepts/config.md).
+For more information on the main config, the tool file, and the var file of DevStream, see [Core Concepts Overview](../core-concepts/overview.md) and [DevStream Configuration](../core-concepts/config.md).
 
 Plugin config example:
 
 ```yaml
 --8<-- "gitlab-ci.yaml"
 ```
 
-Or, run `dtm show config --plugin=gitlab-ci` to get the default config.
+**Notes:**
 
-All parameters are mandatory.
+- `scm` config option represents codebase location; for more info, you can refer to [SCM Config](./scm-option.md).
+- The `pipeline` config option controls `CI` stages; you can refer to [Pipeline Config](./pipeline.md) for more info.

docs/plugins/gitlab-ci.zh.md

@@ -1,17 +1,6 @@
 # gitlab-ci 插件
 
-_该插件用于在使用 gitlab 的项目仓库中创建 Gitlab CI 并运行对应项目的 gitlab runner_
-
-## 用例
-
-_该插件运行依赖以下环境变量：_
-
-- GITLAB_TOKEN
-
-请在使用插件前配置该环境变量。如果你不知道如何创建这个 TOKEN，可以查看以下文档：
-
-- 如果你使用的是官方提供的仓库（非自搭建的 `Gitlab`），可以查看该[链接](https://gitlab.com/-/profile/personal_access_tokens?name=DevStream+Access+token&scopes=api) 来创建一个用于 Devstream 的 token。
-- 如果你使用自搭建的 `Gitlab` 仓库，可以查看该[链接](https://gitlab.com/-/profile/personal_access_tokens?name=DevStream+Access+token&scopes=api)来创建一个用于 Devstream 的 token。
+该插件用于在使用 gitlab 的项目仓库中创建 Gitlab CI 并运行对应项目的 gitlab runner。
 
 ### 配置项
 下面的内容是一个示例配置文件用于创建 Gitlab CI：
@@ -20,4 +9,7 @@ _该插件运行依赖以下环境变量：_
 --8<-- "gitlab-ci.yaml"
 ```
 
-该插件的 `pipeline` 选项具体配置可查询[pipline配置项](pipeline.zh.md)。
+**注意:**
+
+- `scm` 配置字段用于表示代码仓库的配置信息，具体配置可查看[SCM配置项](./scm-option.zh.md)。
+- `pipeline` 选项项用于控制 `CI` 流程中的各个阶段，具体配置可查看文档[pipline配置项](pipeline.zh.md)。

docs/plugins/jenkins-pipeline.md

@@ -1,6 +1,6 @@
 # jenkins-pipeline Plugin
 
-TODO(dtm): Add your document here.
+This plugin is used to create a `Jenkins Pipeline` for Github/Gitlab Repo.
 
 ## Usage
 
@@ -11,3 +11,9 @@ For more information on the main config, the tool file and the var file of DevSt
 ``` yaml
 --8<-- "jenkins-pipeline.yaml"
 ```
+
+**Notes:**
+
+- `scm` config option represents codebase location; for more info, you can refer to [SCM Config](./scm-option.md).
+- The `pipeline` config option controls `CI` stages; you can refer to [Pipeline Config](./pipeline.md) for more info.
+- `jenkins.token` is the password of `jenkins.user`.