hugo: create a common api layout

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-11 12:44:15 +02:00 · 2024-09-11 12:44:15 +02:00 · c17d0e8553
--- a/content/reference/api/engine/version/_index.md
+++ b/content/reference/api/engine/version/_index.md
@ -4,4 +4,7 @@ build:
  render: never
 sidebar:
  reverse: true
+cascade:
+  description: Reference documentation and Swagger (OpenAPI) specification for the Docker Engine API.
+  layout: api
 ---
--- a/content/reference/api/engine/version/v1.25.md
+++ b/content/reference/api/engine/version/v1.25.md
@ -1,6 +1,6 @@
 ---
-title: v1.25
-layout: engine-api
+title: Docker Engine API v1.25 reference
+linkTitle: v1.25
 aliases:
 - /engine/api/v1.25/
 ---
--- a/content/reference/api/engine/version/v1.26.md
+++ b/content/reference/api/engine/version/v1.26.md
@ -1,6 +1,6 @@
 ---
-title: v1.26
-layout: engine-api
+linkTitle: v1.26
+title: Docker Engine API v1.26 reference
 aliases:
 - /engine/api/v1.26/
 ---
--- a/content/reference/api/engine/version/v1.27.md
+++ b/content/reference/api/engine/version/v1.27.md
@ -1,6 +1,6 @@
 ---
-title: v1.27
-layout: engine-api
+linkTitle: v1.27
+title: Docker Engine API v1.27 reference
 aliases:
 - /engine/api/v1.27/
 ---
--- a/content/reference/api/engine/version/v1.28.md
+++ b/content/reference/api/engine/version/v1.28.md
@ -1,6 +1,6 @@
 ---
-title: v1.28
-layout: engine-api
+linkTitle: v1.28
+title: Docker Engine API v1.28 reference
 aliases:
 - /engine/api/v1.28/
 ---
--- a/content/reference/api/engine/version/v1.29.md
+++ b/content/reference/api/engine/version/v1.29.md
@ -1,6 +1,6 @@
 ---
-title: v1.29
-layout: engine-api
+linkTitle: v1.29
+title: Docker Engine API v1.29 reference
 aliases:
  - /engine/api/v1.29/
 ---
--- a/content/reference/api/engine/version/v1.30.md
+++ b/content/reference/api/engine/version/v1.30.md
@ -1,6 +1,6 @@
 ---
-title: v1.30
-layout: engine-api
+linkTitle: v1.30
+title: Docker Engine API v1.30 reference
 aliases:
  - /engine/api/v1.30/
 ---
--- a/content/reference/api/engine/version/v1.31.md
+++ b/content/reference/api/engine/version/v1.31.md
@ -1,6 +1,6 @@
 ---
-title: v1.31
-layout: engine-api
+linkTitle: v1.31
+title: Docker Engine API v1.31 reference
 aliases:
  - /engine/api/v1.31/
 ---
--- a/content/reference/api/engine/version/v1.32.md
+++ b/content/reference/api/engine/version/v1.32.md
@ -1,6 +1,6 @@
 ---
-title: v1.32
-layout: engine-api
+linkTitle: v1.32
+title: Docker Engine API v1.32 reference
 aliases:
  - /engine/api/v1.32/
 ---
--- a/content/reference/api/engine/version/v1.33.md
+++ b/content/reference/api/engine/version/v1.33.md
@ -1,6 +1,6 @@
 ---
-title: v1.33
-layout: engine-api
+linkTitle: v1.33
+title: Docker Engine API v1.33 reference
 aliases:
  - /engine/api/v1.33/
 ---
--- a/content/reference/api/engine/version/v1.34.md
+++ b/content/reference/api/engine/version/v1.34.md
@ -1,6 +1,6 @@
 ---
-title: v1.34
-layout: engine-api
+linkTitle: v1.34
+title: Docker Engine API v1.34 reference
 aliases:
  - /engine/api/v1.34/
 ---
--- a/content/reference/api/engine/version/v1.35.md
+++ b/content/reference/api/engine/version/v1.35.md
@ -1,6 +1,6 @@
 ---
-title: v1.35
-layout: engine-api
+linkTitle: v1.35
+title: Docker Engine API v1.35 reference
 aliases:
  - /engine/api/v1.35/
 ---
--- a/content/reference/api/engine/version/v1.36.md
+++ b/content/reference/api/engine/version/v1.36.md
@ -1,6 +1,6 @@
 ---
-title: v1.36
-layout: engine-api
+linkTitle: v1.36
+title: Docker Engine API v1.36 reference
 aliases:
  - /engine/api/v1.36/
 ---
--- a/content/reference/api/engine/version/v1.37.md
+++ b/content/reference/api/engine/version/v1.37.md
@ -1,6 +1,6 @@
 ---
-title: v1.37
-layout: engine-api
+linkTitle: v1.37
+title: Docker Engine API v1.37 reference
 aliases:
  - /engine/api/v1.37/
 ---
--- a/content/reference/api/engine/version/v1.38.md
+++ b/content/reference/api/engine/version/v1.38.md
@ -1,6 +1,6 @@
 ---
-title: v1.38
-layout: engine-api
+linkTitle: v1.38
+title: Docker Engine API v1.38 reference
 aliases:
  - /engine/api/v1.38/
 ---
--- a/content/reference/api/engine/version/v1.39.md
+++ b/content/reference/api/engine/version/v1.39.md
@ -1,6 +1,6 @@
 ---
-title: v1.39
-layout: engine-api
+linkTitle: v1.39
+title: Docker Engine API v1.39 reference
 aliases:
  - /engine/api/v1.39/
 ---
--- a/content/reference/api/engine/version/v1.40.md
+++ b/content/reference/api/engine/version/v1.40.md
@ -1,6 +1,6 @@
 ---
-title: v1.40
-layout: engine-api
+linkTitle: v1.40
+title: Docker Engine API v1.40 reference
 aliases:
  - /engine/api/v1.40/
 ---
--- a/content/reference/api/engine/version/v1.41.md
+++ b/content/reference/api/engine/version/v1.41.md
@ -1,6 +1,6 @@
 ---
-title: v1.41
-layout: engine-api
+linkTitle: v1.41
+title: Docker Engine API v1.41 reference
 aliases:
  - /engine/api/v1.41/
 ---
--- a/content/reference/api/engine/version/v1.42.md
+++ b/content/reference/api/engine/version/v1.42.md
@ -1,6 +1,6 @@
 ---
-title: v1.42
-layout: engine-api
+linkTitle: v1.42
+title: Docker Engine API v1.42 reference
 aliases:
  - /engine/api/v1.42/
 ---
--- a/content/reference/api/engine/version/v1.43.md
+++ b/content/reference/api/engine/version/v1.43.md
@ -1,6 +1,6 @@
 ---
-title: v1.43
-layout: engine-api
+linkTitle: v1.43
+title: Docker Engine API v1.43 reference
 aliases:
  - /engine/api/v1.43/
 ---
--- a/content/reference/api/engine/version/v1.44.md
+++ b/content/reference/api/engine/version/v1.44.md
@ -1,6 +1,6 @@
 ---
-title: v1.44
-layout: engine-api
+linkTitle: v1.44
+title: Docker Engine API v1.44 reference
 aliases:
  - /engine/api/v1.44/
 ---
--- a/content/reference/api/engine/version/v1.45.md
+++ b/content/reference/api/engine/version/v1.45.md
@ -1,6 +1,6 @@
 ---
-title: v1.45
-layout: engine-api
+linkTitle: v1.45
+title: Docker Engine API v1.45 reference
 aliases:
  - /engine/api/v1.45/
 ---
--- a/content/reference/api/engine/version/v1.46.md
+++ b/content/reference/api/engine/version/v1.46.md
@ -1,6 +1,6 @@
 ---
-title: v1.46
-layout: engine-api
+linkTitle: v1.46
+title: Docker Engine API v1.46 reference
 aliases:
  - /engine/api/v1.46/
 ---
--- a/content/reference/api/engine/version/v1.47.md
+++ b/content/reference/api/engine/version/v1.47.md
@ -1,4 +1,4 @@
 ---
-title: v1.47
-layout: engine-api
+linkTitle: v1.47
+title: Docker Engine API v1.47 reference
 ---
--- a/content/reference/api/hub/dvp.md
+++ b/content/reference/api/hub/dvp.md
@ -1,4 +1,6 @@
 ---
-layout: hub-api
-title: Docker Verified Publisher API
+layout: api
+description: Reference documentation and Swagger (OpenAPI) specification for the Docker Verified Publisher API.
+linkTitle: DVP Data API
+title: Docker Verified Publisher API reference
 ---
--- a/content/reference/api/hub/latest.md
+++ b/content/reference/api/hub/latest.md
@ -1,4 +1,6 @@
 ---
-layout: hub-api
-title: Docker Hub API
+layout: api
+description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API.
+title: Docker Hub API reference
+linkTitle: Docker Hub API
 ---
--- a/hugo.yaml
+++ b/hugo.yaml
@ -262,7 +262,7 @@ module:
        - source: docs/api/version-history.md
          target: content/reference/api/engine/version-history.md
        - source: docs/api
-          target: static/reference/api/engine
+          target: content/reference/api/engine/version
          includeFiles: "*.yaml"

    - path: github.com/moby/buildkit
--- a/hugo_stats.json
+++ b/hugo_stats.json
@ -317,7 +317,6 @@
      "hover:text-black",
      "hover:text-blue-light",
      "hover:underline",
-      "hub-api",
      "icon-lg",
      "icon-sm",
      "icon-svg",
--- a/layouts/_default/api-baseof.html
+++ b/layouts/_default/api-baseof.html
@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <title>{{ .Title }}</title>
+  <!-- needed for adaptive design -->
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="description" content="{{ .Description }}" />
+  <meta charset="utf-8" />
+  <!-- favicon -->
+  {{- partialCached "favicon.html" "favicon" }}
+  <style>
+    body {
+      margin: 0;
+      padding: 0;
+    }
+
+    .menu-content>div:first-child {
+      background-color: #086dd7;
+      padding: 16px;
+    }
+  </style>
+</head>
+
+<body>
+  {{ $specURL := urls.Parse (printf "/%s%s.yaml" .File.Dir .File.ContentBaseName) }}
+  <redoc spec-url="{{ $specURL.String }}" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
+  <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
+</body>
+
+</html>
--- a/layouts/_default/engine-api-baseof.html
+++ b/layouts/_default/engine-api-baseof.html
@ -1,34 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <title>Docker Engine API {{ .File.BaseFileName }} Reference</title>
-    <!-- needed for adaptive design -->
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="description"
-        content="Reference documentation and Swagger (OpenAPI) specification for the {{ .File.BaseFileName }} version of the API served by Docker Engine." />
-    <meta charset="utf-8" />
-    <!-- favicon -->
-    {{ partialCached "favicon.html" "favicon" }}
-    <!-- make the latest API version the canonical page as that's what we want users to be using mostly -->
-    <link rel="canonical" href="{{ site.BaseURL }}/reference/api/engine/version/v{{ site.Params.latest_engine_api_version }}/" />
-    <style>
-        body {
-            margin: 0;
-            padding: 0;
-        }
-
-        .menu-content>div:first-child {
-            background-color: #086dd7;
-            padding: 16px;
-        }
-    </style>
-</head>
-
-<body>
-    <redoc spec-url="/reference/api/engine/{{ .File.BaseFileName }}.yaml" hide-hostname="true" suppress-warnings="true"
-        lazy-rendering></redoc>
-    <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
-</body>
-
-</html>
--- a/layouts/_default/hub-api-baseof.html
+++ b/layouts/_default/hub-api-baseof.html
@ -1,33 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-  <title>Docker Hub API Reference {{ .File.BaseFileName }}</title>
-  <!-- needed for adaptive design -->
-  <meta name="viewport" content="width=device-width, initial-scale=1" />
-  <meta name="description"
-    content="Reference documentation and Swagger (OpenAPI) specification for the {{ .File.BaseFileName }} API served by Docker Hub." />
-  <meta charset="utf-8" />
-  <!-- favicon -->
-  {{ partialCached "favicon.html" "favicon" }}
-  <!-- make the latest API version the canonical page as that's what we want users to be using mostly -->
-  <link rel="canonical" href="{{ "/reference/api/hub/latest/" | relURL }}" />
-  <style>
-    body {
-      margin: 0;
-      padding: 0;
-    }
-
-    .menu-content>div:first-child {
-      background-color: #086dd7;
-      padding: 16px;
-    }
-  </style>
-</head>
-
-<body>
-  <redoc spec-url="/reference/api/hub/{{ .File.BaseFileName }}.yaml" class="hub-api"></redoc>
-  <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
-</body>
-
-</html>