Skip to content

Commit 6d26703

Browse files
committed
docs: update installation documents
Signed-off-by: Daniel Hu <[email protected]>
1 parent 6ce958f commit 6d26703

File tree

3 files changed

+62
-43
lines changed

3 files changed

+62
-43
lines changed

docs/install.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Installation
22

3-
## 0 Currently supported operating systems and chip architectures
3+
!!! note
4+
Currently supported operating systems and chip architectures:
45

5-
* Darwin/arm64
6-
* Darwin/amd64
7-
* Linux/amd64
6+
1. Darwin/arm64
7+
2. Darwin/amd64
8+
3. Linux/amd64
89

910
## 1 Install dtm binary with script
1011

@@ -16,26 +17,21 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
1617

1718
This will download the corresponding `dtm` binary to your working directory according to your OS and chip architecture, and grant the binary execution permission.
1819

19-
> Optional: you can then move `dtm` to a place which is in your PATH. For example: `mv dtm /usr/local/bin/`.
20+
!!! note "Optional"
2021

21-
## 2 Install dtm with [asdf](https://asdf-vm.com/)
22+
Move `dtm` to a place which is in your PATH. For example: `mv dtm /usr/local/bin/`.
23+
24+
## 2 Download manually from the GitHub Release page
25+
26+
You could find the latest version of `dtm` on the [Release](https://github.com/devstream-io/devstream/releases/) page and click Download.
27+
28+
If your browser isn't working properly, "curl" is also a good option:
2229

2330
```shell
24-
# Plugin
25-
asdf plugin add dtm
26-
# Show all installable versions
27-
asdf list-all dtm
28-
# Install specific version
29-
asdf install dtm latest
30-
# Set a version globally (on your ~/.tool-versions file)
31-
asdf global dtm latest
32-
# Now dtm commands are available
33-
dtm help
31+
# Version v0.10.3, OS type linux and CPU arch amd64 need to be modified as needed
32+
$ curl -o dtm https://download.devstream.io/v0.10.3/dtm-linux-amd64
3433
```
3534

36-
## 3 Download manually from the GitHub Release page
37-
38-
You could find the latest version of `dtm` on the [Release](https://github.com/devstream-io/devstream/releases/) page and click Download.
3935
Note that there are multiple versions of `dtm` available, so you will need to choose the correct version for your operating system and chip architecture. Once downloaded locally, you can choose to rename it, move it to the directory containing `$PATH` and give it executable permissions, for example, on Linux you can do this by running the following command.
4036

4137
```shell
@@ -47,5 +43,20 @@ Then you can verify that the permissions and version of dtm are correct with the
4743

4844
```shell
4945
$ dtm version
50-
0.10.0
46+
0.10.3
47+
```
48+
49+
## 3 Install dtm with [asdf](https://asdf-vm.com/)
50+
51+
```shell
52+
# Plugin
53+
asdf plugin add dtm
54+
# Show all installable versions
55+
asdf list-all dtm
56+
# Install specific version
57+
asdf install dtm latest
58+
# Set a version globally (on your ~/.tool-versions file)
59+
asdf global dtm latest
60+
# Now dtm commands are available
61+
dtm help
5162
```

docs/install.zh.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# 安装
22

3-
## 0 当前支持的操作系统与芯片架构
3+
!!! note "提示"
4+
当前 dtm 发行版支持如下操作系统与 CPU 架构组合:
45

5-
* Darwin/arm64
6-
* Darwin/amd64
7-
* Linux/amd64
6+
1. Darwin/arm64
7+
2. Darwin/amd64
8+
3. Linux/amd64
89

910
## 1 用脚本安装
1011

@@ -16,26 +17,21 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
1617

1718
这个命令会根据你的操作系统和芯片架构下载对应的 `dtm` 二进制文件到你的工作目录中,并赋予二进制文件执行权限。
1819

19-
> 可选:建议你将 dtm 移动到包含于 PATH 的目录下,比如 `mv dtm /usr/local/bin/`
20+
!!! note "可选"
2021

21-
## 2 用 [asdf](https://asdf-vm.com/) 安装
22+
将 dtm 移动到包含于 PATH 的目录下,比如 `mv dtm /usr/local/bin/`。
23+
24+
## 2 从 GitHub Release 页面手动下载安装
25+
26+
[Release](https://github.com/devstream-io/devstream/releases/) 页面找到当前最新版本 `dtm`,然后点击下载。
27+
28+
如果你不方便使用浏览器下载,也可以选择使用 curl:
2229

2330
```shell
24-
# 安装 dtm 插件
25-
asdf plugin add dtm
26-
# 列出所有可用版本
27-
asdf list-all dtm
28-
# 安装特定版本
29-
asdf install dtm latest
30-
# 设置全局版本 (在 ~/.tool-versions 文件中)
31-
asdf global dtm latest
32-
# 现在你就能使用 dtm 了
33-
dtm help
31+
# 版本号 v0.10.3,系统类型 linux 和 CPU 架构 amd64 根据需要灵活修改
32+
$ curl -o dtm https://download.devstream.io/v0.10.3/dtm-linux-amd64
3433
```
3534

36-
## 3 从 GitHub Release 页面手动下载
37-
38-
[Release](https://github.com/devstream-io/devstream/releases/) 页面找到当前最新版本 `dtm`,然后点击下载。
3935
需要注意的是当前 `dtm` 提供了多个版本,你需要根据操作系统和芯片架构选择自己需要的正确版本。下载到本地后,你可以选择将其重命名,移入包含在"$PATH"的目录里并赋予其可执行权限,比如在 Linux 上你可以执行如下命令完成这些操作:
4036

4137
```shell
@@ -47,5 +43,20 @@ chmod +x dtm
4743

4844
```shell
4945
$ dtm version
50-
0.10.0
46+
0.10.3
47+
```
48+
49+
## 3 用 [asdf](https://asdf-vm.com/) 安装
50+
51+
```shell
52+
# 安装 dtm 插件
53+
asdf plugin add dtm
54+
# 列出所有可用版本
55+
asdf list-all dtm
56+
# 安装特定版本
57+
asdf install dtm latest
58+
# 设置全局版本 (在 ~/.tool-versions 文件中)
59+
asdf global dtm latest
60+
# 现在你就能使用 dtm 了
61+
dtm help
5162
```

docs/use-cases/gitops-python-flask/4-gitlab-dtm-apps.zh.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,3 @@ cd ../
310310
rm -rf test/
311311
rm -rf ~/.devstream/
312312
```
313-
314-
315-

0 commit comments

Comments
 (0)