Merge pull request #602 from merico-dev/release-0.6

docs: update quickstart for varFile

Author: Tiexin Guo

docs/quickstart_en.md

@@ -15,24 +15,17 @@ For Linux/Macos users:
 
 ## 2 Prepare a Config File
 
-Before you start: for an example of DevStream config, see [examples/tools-quickstart.yaml](https://github.com/devstream-io/devstream/blob/main/examples/tools-quickstart.yaml). Remember to open this configuration file, modify all FULL_UPPER_CASE_STRINGS (like YOUR_GITHUB_USERNAME, for example) in it to your own. Pay attention to the meaning of each item to ensure that it is what you want. For other plugins, checkout the "Plugins" section in our [doc](https://docs.devstream.io) for detailed usage.
+> Before you start: for an example of DevStream config, see [examples/tools-quickstart.yaml](https://github.com/devstream-io/devstream/blob/main/examples/tools-quickstart.yaml).
 
-Download the [examples/quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/main/examples/quickstart.yaml) and [examples/tools-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/main/examples/tools-quickstart.yaml) to your working directory and rename `quickstart.yaml` to `config.yaml`:
+Download the [examples/quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/quickstart.yaml), [examples/tools-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/tools-quickstart.yaml) and [examples/variables-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/variables-quickstart.yaml) to your working directory and rename `quickstart.yaml` to `config.yaml`:
 
 ```shell
-curl -o config.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/quickstart.yaml
-curl -o tools-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/tools-quickstart.yaml
+curl -o config.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/quickstart.yaml
+curl -o tools-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/tools-quickstart.yaml
+curl -o variables-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/variables-quickstart.yaml
 ```
 
-Then modify the file accordingly.
-
-For example, my GitHub username is "IronCore864", and my Dockerhub username is "ironcore864", then I can run:
-
-```shell
-sed -i.bak "s/YOUR_GITHUB_USERNAME_CASE_SENSITIVE/IronCore864/g" tools-quickstart.yaml
-
-sed -i.bak "s/YOUR_DOCKER_USERNAME/ironcore864/g" tools-quickstart.yaml
-```
+Remember to open the varFile and modify all values to your own. Pay attention to the meaning of each item to ensure that it is what you want. For other plugins, checkout the "Plugins" section in our [doc](https://docs.devstream.io) for detailed usage.
 
 > This config file uses two plugins, one will create a GitHub repository and bootstrap it into a Golang web app, and the other will create GitHub Actions workflow for it.
 

docs/quickstart_zh.md

@@ -12,24 +12,17 @@
 
 ## 2 准备一个配置文件
 
-开始之前：这是一个DevStream配置的例子：[examples/tools-quickstart.yaml](https://github.com/devstream-io/devstream/blob/main/examples/tools-quickstart.yaml) 。记得打开这个配置文件，把里面所有的 `FULL_UPPER_CASE_STRINGS`（比如说 `YOUR_GITHUB_USERNAME` ）修改成你自己的。注意每一项的含义，并确保它是你要的。对于其他插件，请查看我们的 [文档](https://docs.devstream.io) 中的"插件"部分，以了解详细用法。
+> 开始之前：这是一个DevStream配置的例子：[examples/tools-quickstart.yaml](https://github.com/devstream-io/devstream/blob/main/examples/quickstart.yaml)。
 
-将 [examples/quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/main/examples/quickstart.yaml) 和 [examples/tools-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/main/examples/tools-quickstart.yaml) 文件下载到你到工作目录下，然后重命名`quickstart.yaml` 成 `config.yaml`：
+将 [examples/quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/quickstart.yaml), [examples/tools-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/tools-quickstart.yaml) 和 [examples/variables-quickstart.yaml](https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/variables-quickstart.yaml)文件下载到你到工作目录下，然后重命名`quickstart.yaml` 成 `config.yaml`：
 
 ```shell
-curl -o config.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/quickstart.yaml
-curl -o tools-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/tools-quickstart.yaml
+curl -o config.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/quickstart.yaml
+curl -o tools-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/tools-quickstart.yaml
+curl -o variables-quickstart.yaml https://raw.githubusercontent.com/devstream-io/devstream/release-0.6/examples/variables-quickstart.yaml
 ```
 
-然后相应的修改配置文件中的内容。
-
-比如我的 GitHub 用户名是 "IronCore864", 然后我的 Dockerhub 用户名是 "ironcore864"，这样我就可以运行：
-
-```shell
-sed -i.bak "s/YOUR_GITHUB_USERNAME_CASE_SENSITIVE/IronCore864/g" tools-quickstart.yaml
-
-sed -i.bak "s/YOUR_DOCKER_USERNAME/ironcore864/g" tools-quickstart.yaml
-```
+记得打开varFile，把里面所有的值修改成你自己的。注意每一项的含义，并确保它是你要的。对于其他插件，请查看我们的 [文档](https://docs.devstream.io) 中的"插件"部分，以了解详细用法。
 
 > 这个配置文件会使用两个插件，一个用来创建 GitHub 项目，而且初始化成一个 Golang 的 web 应用结构。接着另外一个插件会给这个项目创建对应的 GitHub Actions 工作流。
 

examples/quickstart.yaml

@@ -1,3 +1,5 @@
+# var file path, you can set it to absolute path or relative path.
+varFile: variables-quickstart.yaml # here is a relative path. (defaults is ./variables.yaml)
 # tool file path, you can set it to absolute path or relative path.
 toolFile: tools-quickstart.yaml # here is a relative path.
 # state config, backend can be local or s3

examples/tools-quickstart.yaml

@@ -3,15 +3,15 @@ tools:
 - name: github-repo-scaffolding-golang
   instanceID: default
   options:
-    owner: YOUR_GITHUB_USERNAME_CASE_SENSITIVE
+    owner: [[ githubUsername ]]
     repo: go-webapp-devstream-demo
     branch: main
-    image_repo: YOUR_DOCKER_USERNAME/go-webapp-devstream-demo
+    image_repo: [[ dockerhubUsername ]]/go-webapp-devstream-demo
 - name: githubactions-golang
   instanceID: default
   dependsOn: ["github-repo-scaffolding-golang.default"]
   options:
-    owner: YOUR_GITHUB_USERNAME_CASE_SENSITIVE
+    owner: [[ githubUsername ]]
     repo: go-webapp-devstream-demo
     language:
       name: go