Skip to content

Commit 8c63c7f

Browse files
authored
Merge pull request #1427 from merico-dev/docs-ht
docs: update the table-of-content with use cases
2 parents ded1004 + 06008e0 commit 8c63c7f

File tree

4 files changed

+11
-34
lines changed

4 files changed

+11
-34
lines changed

docs/commands/autocomplete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Once the installation is complete, you need to integrate the terminal you are us
3838

3939
#### On Linux
4040

41-
**Note: Main reference [bash auto-completion on Linux](https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-linux/)**
41+
**Note: Main reference [Install and Set Up kubectl on Linux](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#enable-shell-autocompletion)**
4242

4343
The completion script depends on `bash-completion`, So you have to install it first.
4444

@@ -70,7 +70,7 @@ After reloading your shell, dtm autocompletion should be working!
7070

7171
```{admonition} Note
7272
:class: note
73-
Main reference [bash auto-completion on macOS](https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-mac/)
73+
Main reference [Install and Set Up kubectl on macOS](https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/#enable-shell-autocompletion)
7474
```
7575

7676
The completion script depends on `bash-completion`, So you have to install it first.

docs/commands/autocomplete.zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
#### Linux
4040

41-
**注:主要参考了 [Linux 上的 bash 自动补全](https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-linux/)**
41+
**注:主要参考了 [Install and Set Up kubectl on Linux](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#enable-shell-autocompletion)**
4242

4343
自动补全脚本依赖于 `bash-completion`, 需要提前安装:
4444

@@ -71,7 +71,7 @@ source ~/.bashrc
7171

7272
```{admonition} Note
7373
:class: note
74-
主要参考了 [MacOS 上的 bash 自动补全](https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-mac/)
74+
主要参考了 [Install and Set Up kubectl on macOS](https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/#enable-shell-autocompletion)
7575
```
7676

7777
自动补全脚本依赖于 `bash-completion`, 需要提前安装:

docs/use-cases/case-overview.zh.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
11
# 场景概览
22

3-
你可以从不同的维度筛选适合自己的使用场景:
4-
5-
=== "DevOps 工具集"
6-
7-
## GitLab,Jenkins 和 Harbor
8-
9-
1. [从0到1在自建(On-Premise)环境通过 DevStream 部署完整的 GitLab + Jenkins + Harbor 工具链](./gitlab-jenkins-harbor/2-gitlab-jenkins-harbor.zh.md);
10-
2. [用 DevStream 部署 Jenkins 并且一键打通其与你的企业内自建 GitLab](./gitlab-jenkins-harbor/4-jenkins-gitlab-integ.zh.md);
11-
3. [通过 DevStream 实现 Java Spring Boot 项目脚手架的快速创建与 Jenkins CI 流水线的自动化配置](./gitlab-jenkins-harbor/5-java-springboot-pipeline-with-gitlab-jenkins-harbor.zh.md);
12-
4. [用 DevStream 部署 GitLab + Jenkins + Harbor 工具链,管理 Java Spring Boot 项目开发生命周期全流程](./gitlab-jenkins-harbor/6-gitlab-jenkins-harbor-java-springboot.zh.md);
13-
14-
## GitLab,Jenkins 和 Harbor(离线环境)
15-
16-
1. [在离线环境通过 DevStream 部署 GitLab + Jenkins + Harbor 工具链](./gitlab-jenkins-harbor/3-gitlab-jenkins-harbor-air-gapped.zh.md);
17-
2. [在离线环境使用 DevStream 搭建 GitLab + Jenkins + Harbor 工具链,管理 Java Spring Boot 项目开发生命周期全流程](./gitlab-jenkins-harbor/7-java-springboot-pipeline-with-gitlab-jenkins-harbor-air-gapped.zh.md)。
18-
19-
## GitOps(Argo CD)
20-
21-
1. [用 DTM 实现基于 Argo CD 的 GitOps 流程](./gitops/2-gitops-tools.zh.md)
22-
2. [用 DTM Apps 管理能力实现基于 Argo CD 的 GitOps 流程](./gitops/3-gitops-apps.zh.md)
23-
3. [用 DTM Apps 实现基于 GitHub,Argo CD 和 GitHub Actions 的 CICD 流程](./gitops-python-flask/2-github-dtm-apps.zh.md)
24-
4. [用 DTM Tools 实现基于 GitHub,Argo CD 和 GitHub Actions 的 CICD 流程](./gitops-python-flask/3-github-dtm-tools.zh.md)
25-
5. [用 DevStream 搭建 Gitlab CI + Argo CD 工具链,管理 Python Flask 项目](./gitops-python-flask/4-gitlab-dtm-apps.zh.md)
26-
3+
左侧的导航目录默认是以“工具集”的维度来区分的,如果你明确知道自己想要使用哪些工具来搭建自己的 DevOps 工具链,相信这个目录对你来说已经足够了。或者如果你想从开发语言,或者自己团队的状态或阶段等维度筛选适合自己的使用场景,那么你可以参考如下索引:
274

285
=== "开发语言和框架"
296

mkdocs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ plugins:
8383
Environment Setup and Development: "Environment Setup and Development"
8484
Docs Contribution: "Docs Contribution"
8585
Helm Installer: "Helm Installer"
86-
GitLab + Jenkins + Harbor Toolchain Management: "GitLab + Jenkins + Harbor Toolchain Management"
8786
zh:
8887
DTM Commands Explained in Depth: "DTM 命令详解"
8988
Plugins: "插件"
9089
Use Cases: "应用场景"
90+
Tools Deployment: "工具部署"
9191
Overview: "概览"
9292
Reference: "参考实践"
9393
Developer Guide: "开发指导"
@@ -102,7 +102,6 @@ plugins:
102102
Environment Setup and Development: "环境搭建与开发"
103103
Docs Contribution: "文档类贡献"
104104
Helm Installer: "Helm 安装器"
105-
GitLab + Jenkins + Harbor Toolchain Management: "GitLab + Jenkins + Harbor 工具链管理"
106105
- literate-nav
107106
nav:
108107
- Overview: .
@@ -122,15 +121,16 @@ nav:
122121
- commands/verify*.md
123122
- Use Cases:
124123
- use-cases/case-overview*.md
125-
- GitLab + Jenkins + Harbor Toolchain Management:
124+
- GitLab + Jenkins + Harbor:
126125
- use-cases/gitlab-jenkins-harbor/*.md
127-
- GitOps with Python Flask:
126+
- GitLab/GitHub + Argo CD:
128127
- use-cases/gitops-python-flask/*.md
129-
- GitOps:
128+
- Tools Deployment:
129+
- use-cases/helm-installer*.md
130+
- GitOps(to be updated):
130131
- use-cases/gitops/*.md
131132
- Reference:
132133
- use-cases/reference/*.md
133-
- use-cases/helm-installer*.md
134134
- Plugins:
135135
- plugins/plugins-list*.md
136136
- Helm Installer:

0 commit comments

Comments
 (0)