Skip to content

Commit 7c45817

Browse files
daniel-hutaosteinliber
authored andcommitted
docs: update quickstart document
Signed-off-by: Daniel Hu <[email protected]>
1 parent e722793 commit 7c45817

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

docs/quickstart.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Quick Start
22

3-
In this quickstart, we will do the following automatically with DevStream:
3+
In this quickstart, you will do the following automatically with DevStream:
44

5-
- create a GitHub repository with automatically generated code for a web application written in Golang with the [gin](https://github.com/gin-gonic/gin) framework;
5+
- create a GitHub repository with automatically generated code for a web application written in Golang with the [Gin](https://github.com/gin-gonic/gin) framework;
66
- set up GitHub Actions workflow for the app created in the previous step.
77

88
---
@@ -20,9 +20,9 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
2020
!!! note "Note"
2121
The command above does the following:
2222

23-
- find out your OS and chip architecture
24-
- find the latest version of the `dtm` binary
25-
- download the correct `dtm` according to OS/architecture
23+
- find out your OS and chip architecture;
24+
- find the latest version of the `dtm` binary;
25+
- download the correct `dtm` according to OS/architecture;
2626
- grant the binary execution permission.
2727

2828
!!! quote "Optional"
@@ -43,16 +43,18 @@ Run the following command to generate the template configuration file `config.ya
4343
Then set the following environment variables by running (replace values within the double quotes):
4444

4545
```shell
46-
export GITHUB_TOKEN="<YOUR_GITHUB_PERSONAL_ACCESS_TOKEN_HERE>"
46+
export GITHUB_USER="<YOUR_GITHUB_USER_NAME_HERE>"
47+
export DOCKERHUB_USERNAME="<YOUR_DOCKER_HUB_USER_NAME_HERE>"
4748
export IMAGE_REPO_PASSWORD="<YOUR_DOCKER_HUB_USER_NAME_HERE>"
49+
export GITHUB_TOKEN="<YOUR_GITHUB_PERSONAL_ACCESS_TOKEN_HERE>"
4850
```
4951

5052
!!! tip "Tip"
5153
Go to [Personal Access Token](https://github.com/settings/tokens/new) to generate a new `GITHUB_TOKEN` for `dtm`.
5254

53-
For "Quick Start", we only need `repo`,`workflow`,`delete_repo` permissions.
55+
For "Quick Start", you only need `repo`,`workflow`,`delete_repo` permissions.
5456

55-
Then we run the following commands to update our config file with those env vars:
57+
Then you should run the following commands to update our config file with those env vars:
5658

5759
=== "**macOS** or **FreeBSD** based systems"
5860

docs/quickstart.zh.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# 快速开始
22

3-
我们将在本文使用 DevStream 自动完成以下操作
3+
在这个“快速开始”流程中,你将使用 DevStream 自动化地完成以下工作
44

5-
- 创建一个包含了 web 应用程序的 GitHub 仓库,代码基于 [gin](https://github.com/gin-gonic/gin) 框架(用Go语言编写)自动生成
6-
- 为前面创建的仓库设置 GitHub Actions 工作流。
5+
- GitHub 上创建一个包含了自动生成的 Golang [Gin](https://github.com/gin-gonic/gin) 框架代码的 web 应用代码库
6+
- 为这个代码库配置好 GitHub Actions 工作流。
77

88
---
99

@@ -18,10 +18,10 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
1818
!!! note "提示"
1919
上面的命令会做以下事情:
2020

21-
- 检测你的操作系统和芯片架构
22-
- 找到最新版本的 `dtm` 二进制文件
23-
- 根据操作系统和架构下载正确的 `dtm` 二进制文件
24-
- 授予二进制文件执行权限
21+
- 检测你的操作系统和芯片架构
22+
- 找到最新版本的 `dtm` 二进制文件
23+
- 根据操作系统和架构下载正确的 `dtm` 二进制文件
24+
- 授予二进制文件执行权限
2525

2626
!!! quote "可选"
2727
你可以将 `dtm` 移到 PATH 中。例如:`mv dtm /usr/local/bin/`
@@ -42,18 +42,19 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
4242

4343
```shell
4444
export GITHUB_USER="<YOUR_GITHUB_USER_NAME_HERE>"
45-
export GITHUB_TOKEN="<YOUR_GITHUB_PERSONAL_ACCESS_TOKEN_HERE>"
4645
export DOCKERHUB_USERNAME="<YOUR_DOCKER_HUB_USER_NAME_HERE>"
46+
export IMAGE_REPO_PASSWORD="<YOUR_DOCKER_HUB_USER_NAME_HERE>"
47+
export GITHUB_TOKEN="<YOUR_GITHUB_PERSONAL_ACCESS_TOKEN_HERE>"
4748
```
4849

4950
!!! tip "提示"
50-
前往 [Personal Access Token](https://github.com/settings/tokens/new)`dtm` 生成新的 `GITHUB_TOKEN`
51+
参考 [Personal Access Token](https://github.com/settings/tokens/new)`dtm` 生成新的 `GITHUB_TOKEN`
5152

52-
对于“快速开始”,我们只需要勾选 `repo`、`workflow`、`delete_repo` 权限。
53+
对于“快速开始”,你只需要勾选 `repo`、`workflow`、`delete_repo` 权限。
5354

54-
接着,让我们运行以下命令,以使用环境变量来修改配置文件:
55+
接着,你可以运行以下命令,以使用环境变量来修改配置文件:
5556

56-
=== "**macOS** 或 基于 **FreeBSD** 的操作系统"
57+
=== "**macOS** 或基于 **FreeBSD** 的操作系统"
5758

5859
```shell title=""
5960
sed -i.bak "s@YOUR_GITHUB_USERNAME_CASE_SENSITIVE@${GITHUB_USER}@g" config.yaml
@@ -69,7 +70,7 @@ export DOCKERHUB_USERNAME="<YOUR_DOCKER_HUB_USER_NAME_HERE>"
6970

7071
---
7172

72-
## 3 初始化
73+
## 3 初始化(Init)
7374

7475
运行:
7576

0 commit comments

Comments
 (0)