Skip to content

Commit

Permalink
fix: broken links
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Hu <tao.hu@merico.dev>
  • Loading branch information
daniel-hutao committed Jan 4, 2023
1 parent a45be6f commit b4e0c1e
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/plugins/argocdapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This plugin creates an [Argo CD Application](https://argo-cd.readthedocs.io/en/s
- Argo CD itself must have been already installed before the usage of this plugin.
To install Argo CD, use the [helm-installer plugin](./helm-installer/argocd.md).
Or you can use both plugins(argocd+argocdapp) at the same time.
See [GitOps Toolchain](../use-cases/gitops.md) for more info.
See [GitOps Toolchain](../use-cases/gitops/2-gitops-tools.md) for more info.
- Currently, only the Helm chart is supported when creating the Argo CD application.

## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/helm-installer/harbor.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ export IMAGE_REPO_ADDR=harbor.devstream.io
./image-pull-push.sh -f harbor-images.txt -r ${IMAGE_REPO_ADDR} -l -u
```

如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../use-cases/image-registry.zh.md)快速部署一个 Docker Registry。
如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../use-cases/reference/image-registry.zh.md)快速部署一个 Docker Registry。

### 5.3、参考配置

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/helm-installer/jenkins.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ export IMAGE_REPO_ADDR=harbor.devstream.io
./image-pull-push.sh -f jenkins-images.txt -r ${IMAGE_REPO_ADDR} -l -u
```

如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../use-cases/image-registry.zh.md)快速部署一个 Docker Registry。
如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../use-cases/reference/image-registry.zh.md)快速部署一个 Docker Registry。

### 5.3、参考配置

Expand Down
2 changes: 1 addition & 1 deletion docs/understanding_the_basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Go through the online Docker and Kubernetes tutorials. You can search for:
## Getting Started

- [Quick Start](./quickstart.md)
- [Best Pratices - GitOps Toolchain](./use-cases/gitops.md)
- [Use Case - GitOps Toolchain](./use-cases/gitops/2-gitops-tools.md)
2 changes: 1 addition & 1 deletion docs/understanding_the_basics.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@
## 让我们开始吧!

- [快速入门](./quickstart.zh.md)
- [最佳实践 - GitOps工具链](./use-cases/gitops.zh.md)
- [用户场景 - GitOps 工具链](./use-cases/gitops/2-gitops-tools.zh.md)
14 changes: 7 additions & 7 deletions docs/use-cases/gitops/2-gitops-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ However, if you are like us, who prefer to do things hands-on and get their hand

DevStream will use the following plugins to achieve the goal described in [Section 0](#0-goal):

1. [repo-scaffolding](../plugins/repo-scaffolding.md)
2. [github-actions](../plugins/github-actions.md)
3. [helm-installer](../plugins/helm-installer/helm-installer.md)
4. [argocdapp](../plugins/argocdapp.md)
1. [repo-scaffolding](../../plugins/repo-scaffolding.md)
2. [github-actions](../../plugins/github-actions.md)
3. [helm-installer](../../plugins/helm-installer/helm-installer.md)
4. [argocdapp](../../plugins/argocdapp.md)

However, you do not have to worry about these plugins because DevStream will manage them automatically for you.

Expand Down Expand Up @@ -113,7 +113,7 @@ Use "dtm [command] --help" for more information about a command.
> Optional: you can move `dtm` to a directory which is in your $PATH. For example: `mv dtm /usr/local/bin/`. This will allow you to run `dtm` directly without having to prefix it with the dot and slash (`./dtm`).
>
> For more methods on how to install DevStream, see [install dtm](../install.md).
> For more methods on how to install DevStream, see [install dtm](../../install.md).
---
Expand Down Expand Up @@ -214,13 +214,13 @@ Let's continue to look at the results of the `apply` command.
The repository is created automatically by DevStream with scaffolding code:
![](../images/gitops-a.png)
![](../../images/gitops-a.png)
### 8.2 CI Pipelines with GitHub Actions
GitHub Actions pipelines are created and executed:
![](../images/gitops-b.png)
![](../../images/gitops-b.png)
### 8.3 Argo CD Installation
Expand Down
14 changes: 7 additions & 7 deletions docs/use-cases/gitops/2-gitops-tools.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@

DevStream 将使用下面的插件来实现[第 0 节](#)中描述的目标:

1. [repo-scaffolding](../plugins/repo-scaffolding.md)
2. [github-actions](../plugins/github-actions.md)
3. [helm-installer](../plugins/helm-installer/helm-installer.md)
4. [argocdapp](../plugins/argocdapp.md)
1. [repo-scaffolding](../../plugins/repo-scaffolding.md)
2. [github-actions](../../plugins/github-actions.md)
3. [helm-installer](../../plugins/helm-installer/helm-installer.md)
4. [argocdapp](../../plugins/argocdapp.md)

不过,你不需要担心这些插件,因为 DevStream 会帮你自动管理它们。

Expand Down Expand Up @@ -113,7 +113,7 @@ Use "dtm [command] --help" for more information about a command.
> 可选:你可以把 `dtm` 移动到 $PATH 环境变量中的某个目录下。例如:`mv dtm /usr/local/bin/`。这样,你就可以直接运行 `dtm` 而不需要再加上 `./` 前缀了。
>
> 更多安装方式详见[安装 dtm](../install.zh.md)。
> 更多安装方式详见[安装 dtm](../../install.zh.md)。
---
Expand Down Expand Up @@ -211,13 +211,13 @@ export IMAGE_REPO_PASSWORD="YOUR_DOCKERHUB_TOKEN_HERE"
DevStream 已经通过 `repo-scaffolding` 插件自动创建了一个仓库:
![](../images/gitops-a.png)
![](../../images/gitops-a.png)
### 8.2 基于 GitHub Actions 的 CI 流水线
GitHub Actions 流水线已经被创建并运行:
![](../images/gitops-b.png)
![](../../images/gitops-b.png)
### 8.3 Argo CD 的安装
Expand Down
6 changes: 3 additions & 3 deletions docs/use-cases/gitops/3-gitops-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 0 Goal

In this tutorial, we will try to use DevStream's new feature "Apps" to achieve similar result to the [GitOps](./gitops-tools.md), but using much less configuration, to show the power of "Apps" in the config. If you haven't read the original GitOps best practice, click the above link first.
In this tutorial, we will try to use DevStream's new feature "Apps" to achieve similar result to the [GitOps](./2-gitops-tools.md), but using much less configuration, to show the power of "Apps" in the config. If you haven't read the original GitOps best practice, click the above link first.

Two applications will be created (one Python, one Golang), CI/CD pipelines will be set up for both, and both apps will be deployed via Argo CD, just like the GitOps best practice.

Expand All @@ -23,7 +23,7 @@ mkdir test
cd test/
```

Download dtm (see the [GitOps](./gitops-tools.md) best practice if you haven't).
Download dtm (see the [GitOps](./2-gitops-tools.md) best practice if you haven't).

Then generate the config file by running:

Expand Down Expand Up @@ -108,7 +108,7 @@ tiexin@mbp ~/work/devstream-io/test $ ./dtm apply -f config.yaml -y
Let's continue to look at the results of the `apply` command.

Similar to what we did in the [GitOps](./gitops-tools.md) best practice, we can check that repositories for two applications are created, CI pipelins are created for both apps too, Argo CD is installed, and both apps are deployed by Argo CD into our Kubernetes cluster.
Similar to what we did in the [GitOps](./2-gitops-tools.md) best practice, we can check that repositories for two applications are created, CI pipelins are created for both apps too, Argo CD is installed, and both apps are deployed by Argo CD into our Kubernetes cluster.

---

Expand Down
6 changes: 3 additions & 3 deletions docs/use-cases/gitops/3-gitops-apps.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 0 目标

在本教程中,我们会使用 DevStream 的新特性 应用(Apps),来达到与 [GitOps](gitops-tools.zh.md) 相似的效果。但它的配置更短,来展示 应用 的强大能力。如果你还没有读过原始的 GitOps 最佳实践,可以先点击前面的链接。
在本教程中,我们会使用 DevStream 的新特性 应用(Apps),来达到与 [GitOps](2-gitops-tools.zh.md) 相似的效果。但它的配置更短,来展示 应用 的强大能力。如果你还没有读过原始的 GitOps 最佳实践,可以先点击前面的链接。

我们会创建两个应用程序(一个基于 Python,另一个是 Go 语言),并且创建共用的 CI/CD 流水线,即两个应用程序都会通过 Argo CD 来部署,就像前面的 GitOps 做到的那样。

Expand All @@ -23,7 +23,7 @@ mkdir test
cd test/
```

下载 dtm(详见 [GitOps](./gitops-tools.zh.md) 最佳实践,如果你还没有下载过的话)
下载 dtm(详见 [GitOps](./2-gitops-tools.zh.md) 最佳实践,如果你还没有下载过的话)

运行以下命令以生成配置文件:

Expand Down Expand Up @@ -106,7 +106,7 @@ tiexin@mbp ~/work/devstream-io/test $ ./dtm apply -f config.yaml -y
让我们来继续看看 `apply` 命令的结果:
与我们在[GitOps](./gitops-tools.zh.md)最佳实践中所做的类似,我们可以检查 dtm 是否为两个应用程序创建了代码仓库并为其创建了 CI 流水线,同时安装了 Argo CD,而且两个应用程序都使用了 Argo CD 来部署到了 Kubernetes 集群中。
与我们在[GitOps](./2-gitops-tools.zh.md)最佳实践中所做的类似,我们可以检查 dtm 是否为两个应用程序创建了代码仓库并为其创建了 CI 流水线,同时安装了 Argo CD,而且两个应用程序都使用了 Argo CD 来部署到了 Kubernetes 集群中。
---
Expand Down

0 comments on commit b4e0c1e

Please sign in to comment.