From f0260dbf20105b86139635a8472785cc27e7dfca Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Fri, 5 Jan 2024 15:53:10 +0100
Subject: [PATCH] hugo: display command aliases

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
---
 .../reference/commandline/container_exec.md   |  1 +
 .../reference/commandline/container_ls.md     |  1 +
 .../reference/commandline/container_run.md    |  1 +
 .../reference/commandline/image_build.md      |  1 +
 .../engine/reference/commandline/image_ls.md  |  1 +
 .../reference/commandline/image_pull.md       |  1 +
 .../reference/commandline/image_push.md       |  1 +
 .../reference/commandline/system_info.md      |  1 +
 layouts/_default/cli.html                     | 23 +++++++++++++++++--
 9 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/content/engine/reference/commandline/container_exec.md b/content/engine/reference/commandline/container_exec.md
index 160a9f65c9..c625285824 100644
--- a/content/engine/reference/commandline/container_exec.md
+++ b/content/engine/reference/commandline/container_exec.md
@@ -1,6 +1,7 @@
 ---
 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/engine/reference/commandline/container_ls.md b/content/engine/reference/commandline/container_ls.md
index 0ec1c74cd3..789bb9947c 100644
--- a/content/engine/reference/commandline/container_ls.md
+++ b/content/engine/reference/commandline/container_ls.md
@@ -1,6 +1,7 @@
 ---
 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/engine/reference/commandline/container_run.md b/content/engine/reference/commandline/container_run.md
index cee6f729e6..5fc495711b 100644
--- a/content/engine/reference/commandline/container_run.md
+++ b/content/engine/reference/commandline/container_run.md
@@ -1,6 +1,7 @@
 ---
 datafolder: engine-cli
 datafile: docker_container_run
+linkTitle: docker run
 title: docker container run
 aliases:
 - /edge/engine/reference/commandline/container_rm/
diff --git a/content/engine/reference/commandline/image_build.md b/content/engine/reference/commandline/image_build.md
index 2c798621e4..50d17e5f9e 100644
--- a/content/engine/reference/commandline/image_build.md
+++ b/content/engine/reference/commandline/image_build.md
@@ -1,6 +1,7 @@
 ---
 datafolder: engine-cli
 datafile: docker_image_build
+linkTitle: docker build
 title: docker image build
 aliases:
 - /edge/engine/reference/commandline/image_build/
diff --git a/content/engine/reference/commandline/image_ls.md b/content/engine/reference/commandline/image_ls.md
index 50668e18a8..8596dac16c 100644
--- a/content/engine/reference/commandline/image_ls.md
+++ b/content/engine/reference/commandline/image_ls.md
@@ -1,6 +1,7 @@
 ---
 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/engine/reference/commandline/image_pull.md b/content/engine/reference/commandline/image_pull.md
index f546aa2267..135fe6156a 100644
--- a/content/engine/reference/commandline/image_pull.md
+++ b/content/engine/reference/commandline/image_pull.md
@@ -1,6 +1,7 @@
 ---
 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/engine/reference/commandline/image_push.md b/content/engine/reference/commandline/image_push.md
index 7838f6365e..c61f1953f7 100644
--- a/content/engine/reference/commandline/image_push.md
+++ b/content/engine/reference/commandline/image_push.md
@@ -1,6 +1,7 @@
 ---
 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/engine/reference/commandline/system_info.md b/content/engine/reference/commandline/system_info.md
index d79767e352..f29a954b3a 100644
--- a/content/engine/reference/commandline/system_info.md
+++ b/content/engine/reference/commandline/system_info.md
@@ -1,6 +1,7 @@
 ---
 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
index ef27d29ad6..04b8ddf5e5 100644
--- a/layouts/_default/cli.html
+++ b/layouts/_default/cli.html
@@ -13,8 +13,16 @@
   {{ .Scratch.Set "subheadings" slice }}
   {{ partial "breadcrumbs.html" . }}
   <article class="DocSearch-content prose max-w-none dark:prose-invert">
-    {{ with .Title }}
-    <h1 class="scroll-mt-36">{{ . }}</h1>
+    {{ if ne .LinkTitle .Title }}
+    {{/*
+      we use linkTitle for surfacing popular aliases like "docker run"
+      if linkTitle is set, use both alias and canonical cmd as title
+    */}}
+    <h1 class="scroll-mt-36">{{ .LinkTitle }}<span
+      class="text-gray-light dark:text-gray-dark"> ({{ .Title }})</span>
+    </h1>
+    {{ else }}
+    <h1 class="scroll-mt-36">{{ .Title }}</h1>
     {{ end }}
     {{ $data.short | .RenderString (dict "display" "block") }}
     {{ if $data.deprecated }}
@@ -57,6 +65,17 @@
       {{ $.Scratch.Add "headings" $heading }}
       {{ highlight (strings.Replace . "\t" "") "console" }}
     {{ end }}
+    {{ with $data.aliases }}
+      {{ $heading := dict "level" 2 "text" "Aliases" }}
+      {{ partial "heading.html" $heading }}
+      {{ $aliases := strings.Split . ", " }}
+      <p>The following commands are equivalent and redirect here:</p>
+      <ul>
+      {{ range $aliases }}
+        <li><code>{{ . }}</code></li>
+      {{ end }}
+      </ul>
+    {{ end }}
     {{ with $data.long }}
       {{ $heading := dict "level" 2 "text" "Description" }}
       {{ partial "heading.html" $heading }}