Merge pull request #24191 from dvdksn/hugo-template-housekeeping

hugo template housekeeping

Author: dvdksn

.github/workflows/validate-upstream.yml

@@ -61,7 +61,7 @@ jobs:
               const yamlSrcFilename = path.basename(yamlSrcPath);
               const yamlSrcNoExt = yamlSrcPath.replace(".yaml", "");
               const hasSubCommands = (await (await glob.create(yamlSrcNoExt)).glob()).length > 1;
-              const yamlDestPath = path.join('data', `${{ inputs.data-files-folder }}`, yamlSrcFilename);
+              const yamlDestPath = path.join('data', 'cli', `${{ inputs.data-files-folder }}`, yamlSrcFilename);
               let placeholderPath = path.join("content/reference/cli", yamlSrcFilename.replace('_', '/').replace(/\.yaml$/, '.md'));
               if (hasSubCommands) {
                 placeholderPath = placeholderPath.replace('.md', '/_index.md');

COMPONENTS.md

@@ -60,6 +60,32 @@ params:
 ---
 ```
 
+### Series (guide) pages
+
+Section pages under `content/guides/` automatically use the `series` layout
+(via a Hugo cascade in `hugo.yaml`). Series pages support additional front
+matter parameters for the metadata card:
+
+```yaml
+---
+title: Getting started
+description: Learn the basics of Docker
+summary: |
+  A longer summary shown on the series landing page.
+params:
+  proficiencyLevel: Beginner
+  time: 15 minutes
+  prerequisites: None
+---
+```
+
+| Field            | Description                              |
+| ---------------- | ---------------------------------------- |
+| summary          | Extended description for the series page |
+| proficiencyLevel | Skill level (Beginner, Intermediate)     |
+| time             | Estimated time to complete               |
+| prerequisites    | Prerequisites or "None"                  |
+
 ## Shortcodes
 
 Shortcodes are reusable components that add rich functionality to your

CONTRIBUTING.md

@@ -111,14 +111,17 @@ If this command doesn't result in any errors, you're good to go!
 
 ## Content not edited here
 
-CLI reference documentation is maintained in upstream repositories. It's
-partially generated from code, and is only vendored here for publishing. To
-update the CLI reference docs, refer to the corresponding repository:
+CLI reference documentation is maintained in upstream repositories and
+generated from YAML data files in `data/cli/`. A Hugo content adapter
+(`content/reference/cli/_content.gotmpl`) turns these data files into pages
+automatically. To update the CLI reference docs, refer to the corresponding
+repository:
 
 - [docker/cli](https://github.com/docker/cli)
 - [docker/buildx](https://github.com/docker/buildx)
 - [docker/compose](https://github.com/docker/compose)
 - [docker/model-runner](https://github.com/docker/model-runner)
+- [docker/mcp-gateway](https://github.com/docker/mcp-gateway)
 
 Feel free to raise an issue on this repository if you're not sure how to
 proceed, and we'll help out.

content/get-started/docker-concepts/building-images/_index.md

@@ -13,9 +13,9 @@ summary: |
   deep dive into the secrets of images, how they are built and best practices.
 layout: series
 params:
-  skill: Beginner
+  proficiencyLevel: Beginner
   time: 25 minutes
-  prereq: None
+  prerequisites: None
 ---
 
 ## About this series

content/get-started/docker-concepts/building-images/build-tag-and-publish-an-image.md

@@ -221,9 +221,9 @@ Now that you have an image built, it's time to push the image to a registry.
 To learn more about building, tagging, and publishing images, visit the following resources:
 
 * [What is a build context?](/build/concepts/context/#what-is-a-build-context)
-* [docker build reference](/engine/reference/commandline/image_build/)
-* [docker image tag reference](/engine/reference/commandline/image_tag/)
-* [docker push reference](/engine/reference/commandline/image_push/)
+* [docker build reference](/reference/cli/docker/buildx/build/)
+* [docker image tag reference](/reference/cli/docker/image/tag/)
+* [docker push reference](/reference/cli/docker/image/push/)
 * [What is a registry?](/get-started/docker-concepts/the-basics/what-is-a-registry/)
 
 ## Next steps

content/get-started/docker-concepts/building-images/writing-a-dockerfile.md

@@ -152,7 +152,7 @@ Now that you have the project, you’re ready to create the `Dockerfile`.
 > The `docker init` command will analyze your project and quickly create 
 > a Dockerfile, a `compose.yaml`, and a `.dockerignore`, helping you get
 > up and going. Since you're learning about Dockerfiles specifically here, 
-> you won't use it now. But, [learn more about it here](/engine/reference/commandline/init/).
+> you won't use it now. But, [learn more about it here](/reference/cli/docker/init/).
 
 ## Additional resources
 

content/get-started/docker-concepts/the-basics/what-is-an-image.md

@@ -84,7 +84,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
 
 ### Search for and download an image
 
-1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search.md) command:
+1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search/) command:
 
    ```console
    docker search docker/welcome-to-docker
@@ -99,7 +99,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
 
    This output shows you information about relevant images available on Docker Hub.
 
-2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull.md) command.
+2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull/) command.
 
    ```console
    docker pull docker/welcome-to-docker
@@ -127,7 +127,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
 
 ### Learn about the image
 
-1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls.md) command:
+1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls/) command:
 
    ```console
    docker image ls
@@ -146,7 +146,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
    >
    > The image size represented here reflects the uncompressed size of the image, not the download size of the layers.
 
-2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history.md) command:
+2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history/) command:
 
    ```console
    docker image history docker/welcome-to-docker

content/get-started/docker-concepts/the-basics/what-is-docker-compose.md

@@ -138,5 +138,5 @@ This page was a brief introduction to Compose. In the following resources, you c
 
 
 * [Overview of Docker Compose](/compose/)
-* [Overview of Docker Compose CLI](/compose/reference/)
+* [Overview of Docker Compose CLI](/reference/cli/docker/compose/)
 * [How Compose works](/compose/intro/compose-application-model/)

content/get-started/introduction/_index.md

@@ -12,9 +12,9 @@ summary: |
   commands, image creation, and container orchestration.
 layout: series
 params:
-  skill: Beginner
+  proficiencyLevel: Beginner
   time: 15 minutes
-  prereq: None
+  prerequisites: None
 aliases:
   - /guides/getting-started/
 ---

content/get-started/workshop/08_using_compose.md

@@ -283,7 +283,7 @@ the way you define and share multi-service applications.
 Related information:
  - [Compose overview](/manuals/compose/_index.md)
  - [Compose file reference](/reference/compose-file/_index.md)
- - [Compose CLI reference](/reference/cli/docker/compose/_index.md)
+ - [Compose CLI reference](/reference/cli/docker/compose/)
 
 ## Next steps