Merge pull request #1377 from devstream-io/tiexin/DTM-549-best-practi…

…ce-restructure docs: restructure and rename best practice to use case
devstream-io · Dec 26, 2022 · 54016e8 · 54016e8
2 parents ac66570 + 13d5ca7
commit 54016e8
Show file tree

Hide file tree

Showing 35 changed files with 13 additions and 13 deletions.
diff --git a/docs/plugins/argocdapp.md b/docs/plugins/argocdapp.md
@@ -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](../best-practices/gitops.md) for more info.
+  See [GitOps Toolchain](../use-cases/gitops.md) for more info.
 - Currently, only the Helm chart is supported when creating the Argo CD application.
 - Modify the file accordingly. Especially remember to modify `ARGOCD_TOOL_NAME`.
 

diff --git a/docs/plugins/helm-installer/harbor.zh.md b/docs/plugins/helm-installer/harbor.zh.md
@@ -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
 ```
 
-如果你还没有一个私有镜像仓库，可以参考[这篇文章](../../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。
+如果你还没有一个私有镜像仓库，可以参考[这篇文章](../../use-cases/image-registry.zh.md)快速部署一个 Docker Registry。
 
 ### 5.3、参考配置
 

diff --git a/docs/plugins/helm-installer/jenkins.zh.md b/docs/plugins/helm-installer/jenkins.zh.md
@@ -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
 ```
 
-如果你还没有一个私有镜像仓库，可以参考[这篇文章](../../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。
+如果你还没有一个私有镜像仓库，可以参考[这篇文章](../../use-cases/image-registry.zh.md)快速部署一个 Docker Registry。
 
 ### 5.3、参考配置
 

diff --git a/docs/understanding_the_basics.md b/docs/understanding_the_basics.md
@@ -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](./best-practices/gitops.md)
+- [Best Pratices - GitOps Toolchain](./use-cases/gitops.md)
diff --git a/docs/understanding_the_basics.zh.md b/docs/understanding_the_basics.zh.md
@@ -36,4 +36,4 @@
 ## 让我们开始吧！
 
 - [快速入门](./quickstart.zh.md)
-- [最佳实践 - GitOps工具链](./best-practices/gitops.zh.md)
+- [最佳实践 - GitOps工具链](./use-cases/gitops.zh.md)
diff --git a/.../air-gapped-deployment/air-gapped-env.png → .../air-gapped-deployment/air-gapped-env.png b/.../air-gapped-deployment/air-gapped-env.png → .../air-gapped-deployment/air-gapped-env.png
diff --git a/...ir-gapped-deployment/harbor-dashboard.png → ...ir-gapped-deployment/harbor-dashboard.png b/...ir-gapped-deployment/harbor-dashboard.png → ...ir-gapped-deployment/harbor-dashboard.png
diff --git a/...es/air-gapped-deployment/harbor-login.png → ...es/air-gapped-deployment/harbor-login.png b/...es/air-gapped-deployment/harbor-login.png → ...es/air-gapped-deployment/harbor-login.png
diff --git a/...r-gapped-deployment/jenkins-dashboard.png → ...r-gapped-deployment/jenkins-dashboard.png b/...r-gapped-deployment/jenkins-dashboard.png → ...r-gapped-deployment/jenkins-dashboard.png
diff --git a/...s/air-gapped-deployment/jenkins-login.png → ...s/air-gapped-deployment/jenkins-login.png b/...s/air-gapped-deployment/jenkins-login.png → ...s/air-gapped-deployment/jenkins-login.png
diff --git a/docs/best-practices/apps.md → docs/use-cases/apps.md b/docs/best-practices/apps.md → docs/use-cases/apps.md
diff --git a/docs/best-practices/apps.zh.md → docs/use-cases/apps.zh.md b/docs/best-practices/apps.zh.md → docs/use-cases/apps.zh.md
diff --git a/.../gitlab-jenkins-harbor-java-springboot.md → .../gitlab-jenkins-harbor-java-springboot.md b/.../gitlab-jenkins-harbor-java-springboot.md → .../gitlab-jenkins-harbor-java-springboot.md
diff --git a/...tlab-jenkins-harbor-java-springboot.zh.md → ...tlab-jenkins-harbor-java-springboot.zh.md b/...tlab-jenkins-harbor-java-springboot.zh.md → ...tlab-jenkins-harbor-java-springboot.zh.md
diff --git a/...es/gitlab-jenkins-harbor/gitlab-login.png → ...es/gitlab-jenkins-harbor/gitlab-login.png b/...es/gitlab-jenkins-harbor/gitlab-login.png → ...es/gitlab-jenkins-harbor/gitlab-login.png
diff --git a/...s/gitlab-jenkins-harbor/gitlab-status.png → ...s/gitlab-jenkins-harbor/gitlab-status.png b/...s/gitlab-jenkins-harbor/gitlab-status.png → ...s/gitlab-jenkins-harbor/gitlab-status.png
diff --git a/...es/gitlab-jenkins-harbor/gitlab-token.png → ...es/gitlab-jenkins-harbor/gitlab-token.png b/...es/gitlab-jenkins-harbor/gitlab-token.png → ...es/gitlab-jenkins-harbor/gitlab-token.png
diff --git a/...itlab-jenkins-harbor/harbor-dashboard.png → ...itlab-jenkins-harbor/harbor-dashboard.png b/...itlab-jenkins-harbor/harbor-dashboard.png → ...itlab-jenkins-harbor/harbor-dashboard.png
diff --git a/...es/gitlab-jenkins-harbor/harbor-image.png → ...es/gitlab-jenkins-harbor/harbor-image.png b/...es/gitlab-jenkins-harbor/harbor-image.png → ...es/gitlab-jenkins-harbor/harbor-image.png
diff --git a/...es/gitlab-jenkins-harbor/harbor-login.png → ...es/gitlab-jenkins-harbor/harbor-login.png b/...es/gitlab-jenkins-harbor/harbor-login.png → ...es/gitlab-jenkins-harbor/harbor-login.png
diff --git a/...tlab-jenkins-harbor/jenkins-dashboard.png → ...tlab-jenkins-harbor/jenkins-dashboard.png b/...tlab-jenkins-harbor/jenkins-dashboard.png → ...tlab-jenkins-harbor/jenkins-dashboard.png
diff --git a/...s/gitlab-jenkins-harbor/jenkins-login.png → ...s/gitlab-jenkins-harbor/jenkins-login.png b/...s/gitlab-jenkins-harbor/jenkins-login.png → ...s/gitlab-jenkins-harbor/jenkins-login.png
diff --git a/...itlab-jenkins-harbor/jenkins-pipeline.png → ...itlab-jenkins-harbor/jenkins-pipeline.png b/...itlab-jenkins-harbor/jenkins-pipeline.png → ...itlab-jenkins-harbor/jenkins-pipeline.png
diff --git a/...itlab-jenkins-harbor/pipeline-success.png → ...itlab-jenkins-harbor/pipeline-success.png b/...itlab-jenkins-harbor/pipeline-success.png → ...itlab-jenkins-harbor/pipeline-success.png
diff --git a/...itlab-jenkins-harbor/repo-scaffolding.png → ...itlab-jenkins-harbor/repo-scaffolding.png b/...itlab-jenkins-harbor/repo-scaffolding.png → ...itlab-jenkins-harbor/repo-scaffolding.png
diff --git a/...ctices/gitlab-jenkins-harbor/workflow.png → ...-cases/gitlab-jenkins-harbor/workflow.png b/...ctices/gitlab-jenkins-harbor/workflow.png → ...-cases/gitlab-jenkins-harbor/workflow.png
diff --git a/docs/best-practices/gitops.md → docs/use-cases/gitops.md b/docs/best-practices/gitops.md → docs/use-cases/gitops.md
diff --git a/docs/best-practices/gitops.zh.md → docs/use-cases/gitops.zh.md b/docs/best-practices/gitops.zh.md → docs/use-cases/gitops.zh.md
diff --git a/docs/best-practices/gitops/a.png → docs/use-cases/gitops/a.png b/docs/best-practices/gitops/a.png → docs/use-cases/gitops/a.png
diff --git a/docs/best-practices/gitops/b.png → docs/use-cases/gitops/b.png b/docs/best-practices/gitops/b.png → docs/use-cases/gitops/b.png
diff --git a/...-java-springboot-air-gapped-deployment.md → ...-java-springboot-air-gapped-deployment.md b/...-java-springboot-air-gapped-deployment.md → ...-java-springboot-air-gapped-deployment.md
diff --git a/...va-springboot-air-gapped-deployment.zh.md → ...va-springboot-air-gapped-deployment.zh.md b/...va-springboot-air-gapped-deployment.zh.md → ...va-springboot-air-gapped-deployment.zh.md
diff --git a/docs/best-practices/image-registry.md → docs/use-cases/image-registry.md b/docs/best-practices/image-registry.md → docs/use-cases/image-registry.md
diff --git a/docs/best-practices/image-registry.zh.md → docs/use-cases/image-registry.zh.md b/docs/best-practices/image-registry.zh.md → docs/use-cases/image-registry.zh.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,7 +68,7 @@ plugins:
       en:
         DTM Commands Explained in Depth: "DTM Commands Explained in Depth"
         Plugins: "Plugins"
-        Best Practices: "Best Practices"
+        Use Cases: "Use Cases"
         Developer Guide: "Developer Guide"
         Core Concepts: "Core Concepts"
         Commands: "Commands"
@@ -84,7 +84,7 @@ plugins:
       zh:
         DTM Commands Explained in Depth: "DTM 命令详解"
         Plugins: "插件"
-        Best Practices: "最佳实践"
+        Use Cases: "应用场景"
         Developer Guide: "开发指导"
         Core Concepts: "核心概念"
         Commands: "命令"
@@ -114,18 +114,18 @@ nav:
   - commands/*.md
   - commands/develop*.md
   - commands/verify*.md
+- Use Cases:
+  - use-cases/gitops*.md
+  - use-cases/apps*.md
+  - use-cases/gitlab-jenkins-harbor-java-springboot*.md
+  - use-cases/gjh-java-springboot-air-gapped-deployment*.md
+  - use-cases/image-registry*.md
 - Plugins:
   - plugins/plugins-list*.md
   - Helm Installer:
     - plugins/helm-installer/helm-installer*.md
     - plugins/helm-installer/*.md
   - plugins/*.md
-- Best Practices:
-  - best-practices/gitops*.md
-  - best-practices/apps*.md
-  - best-practices/gitlab-jenkins-harbor-java-springboot*.md
-  - best-practices/gjh-java-springboot-air-gapped-deployment*.md
-  - best-practices/image-registry*.md
 - contributing_guide*.md
 - contributor_ladder*.md
 - Governance ⧉: https://github.com/devstream-io/devstream/blob/main/GOVERNANCE.md