docs: reorganize the use cases directory

Signed-off-by: Daniel Hu <tao.hu@merico.dev>
devstream-io · Jan 4, 2023 · 76e5bd0 · 76e5bd0
1 parent 4efa862
commit 76e5bd0
Show file tree

Hide file tree

Showing 13 changed files with 21 additions and 11 deletions.
diff --git a/docs/use-cases/gitlab-jenkins-harbor/3-gitlab-jenkins-harbor-air-gapped.zh.md b/docs/use-cases/gitlab-jenkins-harbor/3-gitlab-jenkins-harbor-air-gapped.zh.md
@@ -62,7 +62,7 @@ curl -o image-pull-push.sh https://raw.githubusercontent.com/devstream-io/devstr
 chmod +x image-pull-push.sh
 ```
 
-如果你还没有一个私有镜像仓库，可以参考[这篇文章](../image-registry.zh.md)快速部署一个 Docker Registry。
+如果你还没有一个私有镜像仓库，可以参考[这篇文章](../reference/image-registry.zh.md)快速部署一个 Docker Registry。
 
 接下来，你就可以通过下述命令快速完成镜像的下载和上传了：
 

diff --git a/...s-harbor/7-java-springboot-pipeline-with-gitlab-jenkins-harbor-air-gapped.zh.md b/...s-harbor/7-java-springboot-pipeline-with-gitlab-jenkins-harbor-air-gapped.zh.md
@@ -68,7 +68,7 @@ curl -o image-pull-push.sh https://raw.githubusercontent.com/devstream-io/devstr
 chmod +x image-pull-push.sh
 ```
 
-如果你还没有一个私有镜像仓库，可以参考[这篇文章](../image-registry.zh.md)快速部署一个 Docker Registry。
+如果你还没有一个私有镜像仓库，可以参考[这篇文章](../reference/image-registry.zh.md)快速部署一个 Docker Registry。
 
 接下来，你就可以通过下述命令快速完成镜像的下载和上传了：
 

diff --git a/docs/use-cases/gitops/1-overview.md b/docs/use-cases/gitops/1-overview.md
@@ -0,0 +1 @@
+# Overview
diff --git a/docs/use-cases/gitops/1-overview.zh.md b/docs/use-cases/gitops/1-overview.zh.md
@@ -0,0 +1 @@
+# 概览
diff --git a/docs/use-cases/gitops.md → docs/use-cases/gitops/2-gitops-tools.md b/docs/use-cases/gitops.md → docs/use-cases/gitops/2-gitops-tools.md
diff --git a/docs/use-cases/gitops.zh.md → docs/use-cases/gitops/2-gitops-tools.zh.md b/docs/use-cases/gitops.zh.md → docs/use-cases/gitops/2-gitops-tools.zh.md
diff --git a/docs/use-cases/apps.md → docs/use-cases/gitops/3-gitops-apps.md b/docs/use-cases/apps.md → docs/use-cases/gitops/3-gitops-apps.md
@@ -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.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](./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.
 
@@ -23,7 +23,7 @@ mkdir test
 cd test/
 ```
 
-Download dtm (see the [GitOps](./gitops.md) best practice if you haven't).
+Download dtm (see the [GitOps](./gitops-tools.md) best practice if you haven't).
 
 Then generate the config file by running:
 
@@ -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.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](./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.
 
 ---
 

diff --git a/docs/use-cases/apps.zh.md → docs/use-cases/gitops/3-gitops-apps.zh.md b/docs/use-cases/apps.zh.md → docs/use-cases/gitops/3-gitops-apps.zh.md
@@ -2,7 +2,7 @@
 
 ## 0 目标
 
-在本教程中，我们会使用 DevStream 的新特性 应用（Apps），来达到与 [GitOps](gitops.zh.md) 相似的效果。但它的配置更短，来展示 应用 的强大能力。如果你还没有读过原始的 GitOps 最佳实践，可以先点击前面的链接。
+在本教程中，我们会使用 DevStream 的新特性 应用（Apps），来达到与 [GitOps](gitops-tools.zh.md) 相似的效果。但它的配置更短，来展示 应用 的强大能力。如果你还没有读过原始的 GitOps 最佳实践，可以先点击前面的链接。
 
 我们会创建两个应用程序（一个基于 Python，另一个是 Go 语言），并且创建共用的 CI/CD 流水线，即两个应用程序都会通过 Argo CD 来部署，就像前面的 GitOps 做到的那样。
 
@@ -23,7 +23,7 @@ mkdir test
 cd test/
 ```
 
-下载 dtm（详见 [GitOps](./gitops.zh.md) 最佳实践，如果你还没有下载过的话）
+下载 dtm（详见 [GitOps](./gitops-tools.zh.md) 最佳实践，如果你还没有下载过的话）
 
 运行以下命令以生成配置文件：
 
@@ -106,7 +106,7 @@ tiexin@mbp ~/work/devstream-io/test $ ./dtm apply -f config.yaml -y
 
 让我们来继续看看 `apply` 命令的结果：
 
-与我们在[GitOps](./gitops.zh.md)最佳实践中所做的类似，我们可以检查 dtm 是否为两个应用程序创建了代码仓库并为其创建了 CI 流水线，同时安装了 Argo CD，而且两个应用程序都使用了 Argo CD 来部署到了 Kubernetes 集群中。
+与我们在[GitOps](./gitops-tools.zh.md)最佳实践中所做的类似，我们可以检查 dtm 是否为两个应用程序创建了代码仓库并为其创建了 CI 流水线，同时安装了 Argo CD，而且两个应用程序都使用了 Argo CD 来部署到了 Kubernetes 集群中。
 
 ---
 

diff --git a/docs/use-cases/overview.md b/docs/use-cases/overview.md
@@ -0,0 +1 @@
+# Overview
diff --git a/docs/use-cases/overview.zh.md b/docs/use-cases/overview.zh.md
@@ -0,0 +1 @@
+# 概览
diff --git a/docs/use-cases/image-registry.md → docs/use-cases/reference/image-registry.md b/docs/use-cases/image-registry.md → docs/use-cases/reference/image-registry.md
diff --git a/docs/use-cases/image-registry.zh.md → .../use-cases/reference/image-registry.zh.md b/docs/use-cases/image-registry.zh.md → .../use-cases/reference/image-registry.zh.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -69,6 +69,8 @@ plugins:
         DTM Commands Explained in Depth: "DTM Commands Explained in Depth"
         Plugins: "Plugins"
         Use Cases: "Use Cases"
+        Overview: "Overview"
+        Reference: "Reference"
         Developer Guide: "Developer Guide"
         Core Concepts: "Core Concepts"
         Commands: "Commands"
@@ -86,6 +88,8 @@ plugins:
         DTM Commands Explained in Depth: "DTM 命令详解"
         Plugins: "插件"
         Use Cases: "应用场景"
+        Overview: "概览"
+        Reference: "参考实践"
         Developer Guide: "开发指导"
         Core Concepts: "核心概念"
         Commands: "命令"
@@ -117,13 +121,15 @@ nav:
   - commands/develop*.md
   - commands/verify*.md
 - Use Cases:
+  - use-cases/overview*.md
   - GitLab + Jenkins + Harbor Toolchain Management:
     - use-cases/gitlab-jenkins-harbor/*.md
   - GitOps with Python Flask:
     - use-cases/gitops-python-flask/*.md
-  - use-cases/gitops*.md  
-  - use-cases/apps*.md
-  - use-cases/image-registry*.md
+  - GitOps:
+    - use-cases/gitops/*.md
+  - Reference:
+    - use-cases/reference/*.md 
 - Plugins:
   - plugins/plugins-list*.md
   - Helm Installer: