feat: update docs for env config usage

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

Author: steinliber

docs/plugins/jenkins-pipeline.zh.md

@@ -39,17 +39,15 @@
 ```shell
 export IMAGE_REPO_PASSWORD=YOUR_IMAGE_REPO_PASSWORD
 export GITLAB_TOKEN=YOUR_GITLAB_TOKEN
-export GITLAB_SSHKEY=YOUR_REPO_PRIVATE_KEY
 ```
 
 !!! tip "提示"
 
     如果是 GitHub，则这里的环境变量改成：
-    
+
     ```shell
     export IMAGE_REPO_PASSWORD=YOUR_IMAGE_REPO_PASSWORD
     export GITHUB_TOKEN=YOUR_GITHUB_TOKEN
-    export GITHUB_SSHKEY=YOUR_REPO_PRIVATE_KEY
     ```
 
 然后准备 DevStream 插件配置：
@@ -70,6 +68,7 @@ tools:
       branch: master
       scmType: gitlab
       baseURL: YOUR_GITLAB_ADDR
+      token: [[ env GITLAB_TOKEN ]]
     sourceRepo:
       owner:  devstream-io
       name: dtm-repo-scaffolding-java-springboot
@@ -86,12 +85,14 @@ tools:
       url: git@YOUR_REPO_CLONE_ADDRESS/root/spring-demo
       branch: master
       apiURL: YOUR_JENKINS_ADDR
+      token: [[ env GITLAB_TOKEN ]]
     pipeline:
       jobName: test-job
       configLocation: https://raw.githubusercontent.com/devstream-io/dtm-jenkins-pipeline-example/main/springboot/Jenkinsfile
       imageRepo:
         url: YOUR_HARBOR_ADDR
         user: admin
+        password: [[ env IMAGE_REPO_PASSWORD ]]
 ```
 
 上述配置文件中使用的 GitLab、Jenkins 和 Harbor 访问地址需要替换成你的环境中实际地址。例如：
@@ -232,6 +233,7 @@ apps:
   repo:
     url: gitlab.com/root/test.git
     branch: main
+    token: [[ env GITLAB_TOKEN ]]
   repoTemplate:
     url: https://github.com/devstream-io/dtm-repo-scaffolding-java-springboot.git
   ci:
@@ -249,6 +251,7 @@ pipelineTemplates:
       offline: true # 在此处设置 offline 为 true， 即开启该 jenkins-pipeline 的离线模式
     imageRepo:
       user: repoUser
+      password: [[ env IMAGE_REPO_PASSWORD ]]
 ```
 
 使用该配置可得到以下输出：

docs/plugins/repo-scaffolding.zh.md

@@ -6,13 +6,15 @@
 
 这个插件基于你使用的代码仓库类型需要设置以下配置：
 
+使用该插件前去要获取对应 Scm（Github/Gitlab） 的 token，如果你不知道如何去获取这个 token，可以查看以下不同的 Scm 的获取方式
+
 ### GitHub
 
-- GITHUB_TOKEN: 在使用插件之前请先设置这个环境变量，如果你不知道如何获取这个 token，可以查看文档 [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)。
+- [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)。
 
 ### GitLab
 
-- GITLAB_TOKEN： 在使用插件之前请先设置这个环境变量，如果你不知道如何获取这个 token，可以查看文档 [Personal access tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。
+- [Personal access tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。
 - `destinationRepo.baseUrl`：如果你使用的是自建的 GitLab 仓库，需要将该配置设置为自建 GItLab 的 URL 地址。
 - `destinationRepo.visibility`：此配置用于设置新建仓库的权限，支持的选项有 `public`, `private` 和 `internal`。
 

docs/use-cases/gitlab-jenkins-harbor/5-java-springboot-pipeline-with-gitlab-jenkins-harbor.zh.md

@@ -85,6 +85,7 @@ apps:
   repo:
     url: [[ gitlabURL ]]/root/[[ appName ]].git
     branch: main
+    token: [[ env GITLAB_TOKEN ]]
   repoTemplate:
     url: https://github.com/devstream-io/dtm-repo-scaffolding-java-springboot.git
   ci:
@@ -99,9 +100,11 @@ pipelineTemplates:
       url: [[ jenkinsURL ]]
       user: admin
       enableRestart: true
+      password: [[ env JENKINS_PASSWORD ]]
     imageRepo:
       user: admin
       url: [[ harborURL ]]/library
+      password: [[ env IMAGE_REPO_PASSWORD ]]
 ```
 
 你可以将这个配置文件放到服务器上的某一个路径内，比如 `~/devstream-test/config-apps.yaml`。

docs/use-cases/gitlab-jenkins-harbor/6-gitlab-jenkins-harbor-java-springboot.zh.md

@@ -395,6 +395,7 @@ apps:
   repo:
     url: [[ gitlabURL ]]/root/[[ appName ]].git
     branch: main
+    token: [[ env GITLAB_TOKEN ]]
   repoTemplate:
     url: https://github.com/devstream-io/dtm-repo-scaffolding-java-springboot.git
   ci:
@@ -409,9 +410,11 @@ pipelineTemplates:
       url: [[ jenkinsURL ]]
       user: admin
       enableRestart: true
+      password: [[ env JENKINS_PASSWORD ]]
     imageRepo:
       user: admin
       url: [[ harborURL ]]/library
+      password: [[ env IMAGE_REPO_PASSWORD ]]
 ```
 
 可以看到这里的状态配置换成了 devstream-app.state，这里需要保证和前面 tools 所使用的状态文件不是同一个。

docs/use-cases/gitops-python-flask/2-github-dtm-apps.md

@@ -35,13 +35,15 @@ apps:
     framework: django
   repo:
     url: github.com/[[ GITHUB_USER ]]/myapp1
+    token: [[ env GITHUB_TOKEN ]]
   repoTemplate:
     url: github.com/devstream-io/dtm-repo-scaffolding-python-flask
   ci:
   - type: github-actions
     options:
       imageRepo:
         user: [[ DOCKERHUB_USER ]]
+        password: [[ env IMAGE_REPO_PASSWORD ]]
   cd:
   - type: argocdapp
 ```