Merge pull request #21756 from dvdksn/cli-aliases-sidebar

cli: add common top-level aliases to sidebar
docker · Jan 13, 2025 · ab43bae · ab43bae
2 parents 2a11e52 + a2d2b07
commit ab43bae
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 12 deletions.
diff --git a/content/reference/cli/docker/build.md b/content/reference/cli/docker/build.md
@@ -0,0 +1,7 @@
+---
+title: docker build
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/buildx/build/
+---
diff --git a/content/reference/cli/docker/container/exec.md b/content/reference/cli/docker/container/exec.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_container_exec
-linkTitle: docker exec
 title: docker container exec
 aliases:
 - /edge/engine/reference/commandline/container_exec/

diff --git a/content/reference/cli/docker/container/ls.md b/content/reference/cli/docker/container/ls.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_container_ls
-linkTitle: docker ps
 title: docker container ls
 aliases:
 - /edge/engine/reference/commandline/container_ls/

diff --git a/content/reference/cli/docker/container/run.md b/content/reference/cli/docker/container/run.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_container_run
-linkTitle: docker run
 title: docker container run
 aliases:
 - /engine/reference/commandline/container_run/

diff --git a/content/reference/cli/docker/exec.md b/content/reference/cli/docker/exec.md
@@ -0,0 +1,7 @@
+---
+title: docker exec
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/container/exec/
+---
diff --git a/content/reference/cli/docker/image/ls.md b/content/reference/cli/docker/image/ls.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_image_ls
-linkTitle: docker images
 title: docker image ls
 aliases:
 - /edge/engine/reference/commandline/image_ls/

diff --git a/content/reference/cli/docker/image/pull.md b/content/reference/cli/docker/image/pull.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_image_pull
-linkTitle: docker pull
 title: docker image pull
 aliases:
 - /edge/engine/reference/commandline/image_pull/

diff --git a/content/reference/cli/docker/image/push.md b/content/reference/cli/docker/image/push.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_image_push
-linkTitle: docker push
 title: docker image push
 aliases:
 - /edge/engine/reference/commandline/image_push/

diff --git a/content/reference/cli/docker/images.md b/content/reference/cli/docker/images.md
@@ -0,0 +1,7 @@
+---
+title: docker images
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/image/ls/
+---
diff --git a/content/reference/cli/docker/info.md b/content/reference/cli/docker/info.md
@@ -0,0 +1,7 @@
+---
+title: docker info
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/system/info/
+---
diff --git a/content/reference/cli/docker/ps.md b/content/reference/cli/docker/ps.md
@@ -0,0 +1,7 @@
+---
+title: docker ps
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/container/ls/
+---
diff --git a/content/reference/cli/docker/pull.md b/content/reference/cli/docker/pull.md
@@ -0,0 +1,7 @@
+---
+title: docker pull
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/image/pull/
+---
diff --git a/content/reference/cli/docker/push.md b/content/reference/cli/docker/push.md
@@ -0,0 +1,7 @@
+---
+title: docker push
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/image/push/
+---
diff --git a/content/reference/cli/docker/run.md b/content/reference/cli/docker/run.md
@@ -0,0 +1,7 @@
+---
+title: docker run
+build:
+  render: never
+sidebar:
+  goto: /reference/cli/docker/container/run/
+---
diff --git a/content/reference/cli/docker/system/info.md b/content/reference/cli/docker/system/info.md
@@ -1,7 +1,6 @@
 ---
 datafolder: engine-cli
 datafile: docker_system_info
-linkTitle: docker info
 title: docker system info
 aliases:
 - /edge/engine/reference/commandline/system_info/

diff --git a/layouts/_default/cli.html b/layouts/_default/cli.html
@@ -183,11 +183,13 @@ <h1 class="scroll-mt-36">{{ .Title }}</h1>
         </thead>
         <tbody>
           {{ range .Pages }}
-            <tr>
-              <td class="text-left"><a class="link" href="{{ .Permalink }}"><code>{{ .Title }}</code></a></th>
-              {{ $data := index (index site.Data .Params.datafolder) .Params.datafile }}
-              <td class="text-left">{{ $data.short }}</th>
-            </tr>
+            {{- if and .Params.datafolder .Params.datafile }}
+              <tr>
+                <td class="text-left"><a class="link" href="{{ .Permalink }}"><code>{{ .Title }}</code></a></th>
+                {{ $data := index (index site.Data .Params.datafolder) .Params.datafile }}
+                <td class="text-left">{{ $data.short }}</th>
+              </tr>
+            {{- end }}
           {{ end }}
         </tbody>
       </table>