diff --git a/content/contribute/file-conventions.md b/content/contribute/file-conventions.md index fe8b44ed0c..8f260e8705 100644 --- a/content/contribute/file-conventions.md +++ b/content/contribute/file-conventions.md @@ -19,16 +19,18 @@ The front matter of a given page is in a section at the top of the Markdown file that starts and ends with three hyphens. It includes YAML content. The following keys are supported. The title, description, and keywords are required. -| Key | Required | Description | -|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| title | yes | The page title. This is added to the HTML output as a `

` level header. | -| description | yes | A sentence that describes the page contents. This is added to the HTML metadata. It’s not rendered on the page. | -| keywords | yes | A comma-separated list of keywords. These are added to the HTML metadata. | -| aliases | no | A YAML list of pages which should redirect to the current page. At build time, each page listed here is created as an HTML stub containing a 302 redirect to this page. | -| notoc | no | Either `true` or `false`. If `true`, no in-page TOC is generated for the HTML output of this page. Defaults to `false`. Appropriate for some landing pages that have no in-page headings. | -| toc_min | no | Ignored if `notoc` is set to `true`. The minimum heading level included in the in-page TOC. Defaults to `2`, to show `

` headings as the minimum. | -| toc_max | no | Ignored if `notoc` is set to `false`. The maximum heading level included in the in-page TOC. Defaults to `3`, to show `

` headings. Set to the same as `toc_min` to only show `toc_min` level of headings. | -| sitemap | no | Exclude the page from indexing by search engines. When set to `false`, the page is excluded from `sitemap.xml`, and a `` header is added to the page. | +| Key | Required | Description | +|-----------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| title | yes | The page title. This is added to the HTML output as a `

` level header. | +| description | yes | A sentence that describes the page contents. This is added to the HTML metadata. It’s not rendered on the page. | +| keywords | yes | A comma-separated list of keywords. These are added to the HTML metadata. | +| aliases | no | A YAML list of pages which should redirect to the current page. At build time, each page listed here is created as an HTML stub containing a 302 redirect to this page. | +| notoc | no | Either `true` or `false`. If `true`, no in-page TOC is generated for the HTML output of this page. Defaults to `false`. Appropriate for some landing pages that have no in-page headings. | +| toc_min | no | Ignored if `notoc` is set to `true`. The minimum heading level included in the in-page TOC. Defaults to `2`, to show `

` headings as the minimum. | +| toc_max | no | Ignored if `notoc` is set to `false`. The maximum heading level included in the in-page TOC. Defaults to `3`, to show `

` headings. Set to the same as `toc_min` to only show `toc_min` level of headings. | +| sitemap | no | Exclude the page from indexing by search engines. When set to `false`, the page is excluded from `sitemap.xml`, and a `` header is added to the page. | +| sidebar.reverse | no | This parameter for section pages changes the sort order of the pages in that section. Pages that would normally appear at the top, by weight or by title, will instead appear near the bottom, and vice versa. | +| sidebar.goto | no | Set this to change the URL that the sidebar should point to for this entry. See [pageless sidebar entries](#pageless-sidebar-entries). | Here's an example of a valid (but contrived) page metadata. The order of the metadata elements in the front matter isn't important. @@ -60,3 +62,19 @@ The body of the page (with the exception of keywords) starts after the front mat ### Text length Splitting long lines (preferably up to 80 characters) can make it easier to provide feedback on small chunks of text. + +## Pageless sidebar entries + +If you want to add an entry to the sidebar, but you want the link to point somewhere else, you can use the `sidebar.goto` parameter. +This is useful in combination with `build.render` set to `always`, which creates a pageless entry in the sidebar that links to another page. + +```md +--- +title: Dummy sidebar link +build: + render: never +sidebar: + goto: /some/other/page/ +weight: 30 +--- +``` diff --git a/content/learning-paths/_index.md b/content/learning-paths/_index.md index 04236d6d1d..e57f6b2897 100644 --- a/content/learning-paths/_index.md +++ b/content/learning-paths/_index.md @@ -1,5 +1,7 @@ --- title: Learning paths +cascade: + layout: wide description: | Docker Learning Paths offer structured guides to help you master Docker. keywords: docker, learning, paths, tutorials, resources diff --git a/content/reference/api/engine/latest.md b/content/reference/api/engine/latest.md new file mode 100644 index 0000000000..1c69fe44fd --- /dev/null +++ b/content/reference/api/engine/latest.md @@ -0,0 +1,9 @@ +--- +build: + render: never +title: Latest (v{{< param latest_engine_api_version >}}) +params: + sidebar: + goto: "/reference/api/engine/version/v{{< param latest_engine_api_version >}}" +weight: 20 +--- diff --git a/content/reference/api/engine/latest/index.html b/content/reference/api/engine/latest/index.html deleted file mode 100644 index 75babe6c37..0000000000 --- a/content/reference/api/engine/latest/index.html +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Latest (v{{< param latest_engine_api_version >}}) -weight: 20 ---- - - -

Redirecting to the latest version of the Docker Engine API reference. - diff --git a/content/reference/api/engine/version/_index.md b/content/reference/api/engine/version/_index.md index b0f604c81a..743d6bd0e9 100644 --- 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 --- diff --git a/content/reference/api/engine/version/v1.25.md b/content/reference/api/engine/version/v1.25.md index 47bb7ea9a7..df231bd273 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.26.md b/content/reference/api/engine/version/v1.26.md index d9554faf2a..a6d9f65fd3 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.27.md b/content/reference/api/engine/version/v1.27.md index 37e7040a11..787d4248ca 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.28.md b/content/reference/api/engine/version/v1.28.md index 50584c5d2a..83370e18a0 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.29.md b/content/reference/api/engine/version/v1.29.md index 956976ca02..9ea6a23017 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.30.md b/content/reference/api/engine/version/v1.30.md index 5176b96f05..8a3985bf89 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.31.md b/content/reference/api/engine/version/v1.31.md index ebdb3ee6b9..c12fd97069 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.32.md b/content/reference/api/engine/version/v1.32.md index 5369b73ee4..bbd5cce058 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.33.md b/content/reference/api/engine/version/v1.33.md index f7178f24aa..515ffca7ca 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.34.md b/content/reference/api/engine/version/v1.34.md index 1677588e14..b2fb6e96f6 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.35.md b/content/reference/api/engine/version/v1.35.md index d1f60d783c..521e6fb897 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.36.md b/content/reference/api/engine/version/v1.36.md index 76adf2fe2d..712265a9b8 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.37.md b/content/reference/api/engine/version/v1.37.md index 7d6270234c..2fc4ecc3dc 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.38.md b/content/reference/api/engine/version/v1.38.md index 422ff8d281..dcc3f0fab2 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.39.md b/content/reference/api/engine/version/v1.39.md index 6166d0682f..7cb3cba4f4 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.40.md b/content/reference/api/engine/version/v1.40.md index 0ea5645b89..415da168a8 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.41.md b/content/reference/api/engine/version/v1.41.md index a4784ecccc..aa7ec00904 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.42.md b/content/reference/api/engine/version/v1.42.md index 259488b878..607f5da693 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.43.md b/content/reference/api/engine/version/v1.43.md index 5116f61245..ea7aaf2cb2 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.44.md b/content/reference/api/engine/version/v1.44.md index 4cce3b486d..bfad290dc0 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.45.md b/content/reference/api/engine/version/v1.45.md index 5ddd338e07..6f02afc4e7 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.46.md b/content/reference/api/engine/version/v1.46.md index 0cda8539e5..661ad6ab85 100644 --- 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/ --- diff --git a/content/reference/api/engine/version/v1.47.md b/content/reference/api/engine/version/v1.47.md index dafdbad144..ec2eab57f0 100644 --- a/content/reference/api/engine/version/v1.47.md +++ b/content/reference/api/engine/version/v1.47.md @@ -1,4 +1,6 @@ --- -title: v1.47 -layout: engine-api +linkTitle: v1.47 +title: Docker Engine API v1.47 reference +aliases: + - /reference/api/engine/latest/ --- diff --git a/content/reference/api/hub/dvp.md b/content/reference/api/hub/dvp.md index 417d4b9384..1ff43e1dd7 100644 --- 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 --- diff --git a/content/reference/api/hub/latest.md b/content/reference/api/hub/latest.md index c481b87c91..a9cd8fceff 100644 --- 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 --- diff --git a/content/tags/_index.md b/content/tags/_index.md index b502c2f650..f433649861 100644 --- a/content/tags/_index.md +++ b/content/tags/_index.md @@ -1,5 +1,7 @@ --- title: Tags +cascade: + layout: wide --- Here you can browse Docker docs by tag. diff --git a/hugo.yaml b/hugo.yaml index 3c7435264f..4b58d50fc6 100644 --- 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 diff --git a/hugo_stats.json b/hugo_stats.json index 21631833e6..ee9b99de61 100644 --- 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", diff --git a/layouts/_default/api-baseof.html b/layouts/_default/api-baseof.html new file mode 100644 index 0000000000..f8002f1921 --- /dev/null +++ b/layouts/_default/api-baseof.html @@ -0,0 +1,31 @@ + + + + + {{ .Title }} + + + + + + {{- partialCached "favicon.html" "favicon" }} + + + + + {{ $specURL := urls.Parse (printf "/%s%s.yaml" .File.Dir .File.ContentBaseName) }} + + + + + diff --git a/layouts/_default/engine-api-baseof.html b/layouts/_default/engine-api-baseof.html deleted file mode 100644 index 82c3bbde58..0000000000 --- a/layouts/_default/engine-api-baseof.html +++ /dev/null @@ -1,34 +0,0 @@ - - - - - Docker Engine API {{ .File.BaseFileName }} Reference - - - - - - {{ partialCached "favicon.html" "favicon" }} - - - - - - - - - - - diff --git a/layouts/_default/hub-api-baseof.html b/layouts/_default/hub-api-baseof.html deleted file mode 100644 index 316da6f0f1..0000000000 --- a/layouts/_default/hub-api-baseof.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - Docker Hub API Reference {{ .File.BaseFileName }} - - - - - - {{ partialCached "favicon.html" "favicon" }} - - - - - - - - - - - diff --git a/layouts/learning-paths/baseof.html b/layouts/_default/wide-baseof.html similarity index 100% rename from layouts/learning-paths/baseof.html rename to layouts/_default/wide-baseof.html diff --git a/layouts/partials/cli-aside.html b/layouts/partials/cli-aside.html index cf7206c820..1321f6d7b2 100644 --- a/layouts/partials/cli-aside.html +++ b/layouts/partials/cli-aside.html @@ -1,5 +1,24 @@

diff --git a/layouts/partials/header.html b/layouts/partials/header.html index a785b542e7..2233af9a87 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -16,7 +16,15 @@ - {{ partial "top-nav.html" . }} +
{{ partialCached "search.html" "-" }} diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html index 7c224e0194..95ae36cd2c 100644 --- a/layouts/partials/sidebar.html +++ b/layouts/partials/sidebar.html @@ -71,12 +71,22 @@ {{ end }} {{ define "renderSingle" }} - {{ $isCurrent := eq page . }} -
  • - {{ markdownify .LinkTitle }} - -
    • + {{- if .Params.goto }} +
  • + + {{ markdownify .LinkTitle }} + +
    • + {{- else }} + {{ $isCurrent := eq page . }} +
  • + {{ markdownify .LinkTitle }} + +
    • + {{- end }} {{ end }} diff --git a/layouts/partials/toc-cli.html b/layouts/partials/toc-cli.html deleted file mode 100644 index a07ab06b0c..0000000000 --- a/layouts/partials/toc-cli.html +++ /dev/null @@ -1,20 +0,0 @@ -
    {{ T "tableOfContents" }}
    - diff --git a/layouts/partials/top-nav.html b/layouts/partials/top-nav.html deleted file mode 100644 index e3c053e694..0000000000 --- a/layouts/partials/top-nav.html +++ /dev/null @@ -1,11 +0,0 @@ -
    - -
    diff --git a/layouts/tag/baseof.html b/layouts/tag/baseof.html deleted file mode 100644 index bf42ff84da..0000000000 --- a/layouts/tag/baseof.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - {{ partial "head.html" . }} - - - - {{ partial "header.html" . }} -
    -
    - {{ block "main" . }} - {{ end }} -
    -
    - - {{/* Load the YouTube player if the page embeds a YouTube video */}} - {{ with .Store.Get "youtube" }} - {{- partial "youtube-script.html" . }} - {{ end }} - - -