Merge pull request #584 from merico-dev/feat-docs

docs: docs structure improvement
devstream-io · May 23, 2022 · f66db80 · f66db80
2 parents 4a104f1 + ec310d7
commit f66db80
Show file tree

Hide file tree

Showing 21 changed files with 22 additions and 12 deletions.
diff --git a/docs/tutorials/best-practices/a.png → docs/best-practices/a.png b/docs/tutorials/best-practices/a.png → docs/best-practices/a.png
diff --git a/docs/tutorials/best-practices/b.png → docs/best-practices/b.png b/docs/tutorials/best-practices/b.png → docs/best-practices/b.png
diff --git a/docs/tutorials/best-practices/c.png → docs/best-practices/c.png b/docs/tutorials/best-practices/c.png → docs/best-practices/c.png
diff --git a/docs/tutorials/best-practices/d.png → docs/best-practices/d.png b/docs/tutorials/best-practices/d.png → docs/best-practices/d.png
diff --git a/docs/tutorials/best-practices/d1.png → docs/best-practices/d1.png b/docs/tutorials/best-practices/d1.png → docs/best-practices/d1.png
diff --git a/docs/tutorials/best-practices/e.png → docs/best-practices/e.png b/docs/tutorials/best-practices/e.png → docs/best-practices/e.png
diff --git a/docs/tutorials/best-practices/f.png → docs/best-practices/f.png b/docs/tutorials/best-practices/f.png → docs/best-practices/f.png
diff --git a/docs/tutorials/best-practices/g.png → docs/best-practices/g.png b/docs/tutorials/best-practices/g.png → docs/best-practices/g.png
diff --git a/docs/tutorials/best-practices/gitops.md → docs/best-practices/gitops.md b/docs/tutorials/best-practices/gitops.md → docs/best-practices/gitops.md
@@ -2,11 +2,11 @@
 
 ## Plugins needed
 
-1. [github-repo-scaffolding-golang](/docs/plugins/github-repo-scaffolding-golang)
-2. [jira-github](/docs/plugins/jira-github-integ)
-3. [githubactions-golang](/docs/plugins/githubactions-golang)
-4. [argocd](/docs/plugins/argocd)
-5. [argocdapp](/docs/plugins/argocdapp)
+1. [github-repo-scaffolding-golang](../plugins/github-repo-scaffolding-golang)
+2. [jira-github](../plugins/jira-github-integ)
+3. [githubactions-golang](../plugins/githubactions-golang)
+4. [argocd](../plugins/argocd)
+5. [argocdapp](../plugins/argocdapp)
 
 The dependencies of these plugins are(`a -> b` means for `a depends on b`):
 
@@ -28,7 +28,7 @@ Download the appropriate `dtm` version for your platform from [DevStream Release
 
 ## Prepare the Config File
 
-Copy the [gitops.yaml](../../../examples/gitops.yaml), [tools-gitops.yaml](../../../examples/tools-gitops.yaml) and [variables-gitops.yaml](../../../examples/variables-gitops.yaml) to your working directory:
+Download the `gitops.yaml`, `tools-gitops.yaml` and `variables-gitops.yaml` to your working directory:
 
 ```bash
 curl -o config-gitops.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/gitops.yaml

diff --git a/docs/tutorials/best-practices/h.png → docs/best-practices/h.png b/docs/tutorials/best-practices/h.png → docs/best-practices/h.png
diff --git a/docs/tutorials/best-practices/i.png → docs/best-practices/i.png b/docs/tutorials/best-practices/i.png → docs/best-practices/i.png
diff --git a/docs/tutorials/autocomplete.md → docs/commands/autocomplete.md b/docs/tutorials/autocomplete.md → docs/commands/autocomplete.md
diff --git a/docs/tutorials/fig/cmd-help.gif → docs/commands/fig/cmd-help.gif b/docs/tutorials/fig/cmd-help.gif → docs/commands/fig/cmd-help.gif
diff --git a/docs/tutorials/fig/cmd-make.gif → docs/commands/fig/cmd-make.gif b/docs/tutorials/fig/cmd-make.gif → docs/commands/fig/cmd-make.gif
diff --git a/docs/tutorials/fig/cmd-show-plugins.gif → docs/commands/fig/cmd-show-plugins.gif b/docs/tutorials/fig/cmd-show-plugins.gif → docs/commands/fig/cmd-show-plugins.gif
diff --git a/docs/tutorials/fig/fig-intro.gif → docs/commands/fig/fig-intro.gif b/docs/tutorials/fig/fig-intro.gif → docs/commands/fig/fig-intro.gif
diff --git a/docs/tutorials/fig/fig-terminal.png → docs/commands/fig/fig-terminal.png b/docs/tutorials/fig/fig-terminal.png → docs/commands/fig/fig-terminal.png
diff --git a/docs/index.md b/docs/index.md
@@ -14,4 +14,4 @@ TL;DR: DevStream (CLI tool named `dtm`) is an open-source DevOps toolchain manag
 ## Get Started
 
 - [Quick Start](quickstart_en.md)
-- [Best Pratices - GitOps Toolchain](tutorials/best-practices/gitops.md)
+- [Best Pratices - GitOps Toolchain](best-practices/gitops.md)
diff --git a/docs/plugins/argocdapp.md b/docs/plugins/argocdapp.md
@@ -6,7 +6,7 @@ This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/st
 - ArgoCD itself must have been already installed before the usage of this plugin.
   To install ArgoCD, use the [argocd plugin](argocd).
   Or you can use both plugins(argocd+argocdapp) at the same time.
-  See [GitOps Toolchain](/docs/tutorials/best-practices/gitops) for more info.
+  See [GitOps Toolchain](/docs/best-practices/gitops) for more info.
 - Currently, only the Helm chart is supported when creating the ArgoCD application.
 - Modify the file accordingly. Especially remember to modify `ARGOCD_TOOL_NAME`.
 

diff --git a/docs/versions.json b/docs/versions.json
@@ -0,0 +1,6 @@
+{
+  "latest": "latest",
+  "versions": {
+    "v0.6.0": "https://docs.devstream.io/en/v0.6.0/"
+  }
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,13 +7,17 @@ site_description: The DevStream Docs
 markdown_extensions:
   toc:
     permalink: true
+extra:
+  version:
+    provider: json
+    index: "https://docs.devstream.io/en/latest/"
+    current: latest
 nav:
   - 'quickstart_en.md'
-  - Tutorials:
-    - 'tutorials/autocomplete.md'
-    - Best Pratices:
-      - 'tutorials/best-practices/gitops.md'
+  - Best Practices:
+    - 'best-practices/gitops.md'
   - Commands:
+    - 'commands/autocomplete.md'
     - 'commands/init.md'
     - 'commands/apply.md'
     - 'commands/verify.md'