Skip to content

Commit 70d0c07

Browse files
committed
site: use content adapters for cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent dde8800 commit 70d0c07

499 files changed

Lines changed: 1164 additions & 6078 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,17 @@ If this command doesn't result in any errors, you're good to go!
111111

112112
## Content not edited here
113113

114-
CLI reference documentation is maintained in upstream repositories. It's
115-
partially generated from code, and is only vendored here for publishing. To
116-
update the CLI reference docs, refer to the corresponding repository:
114+
CLI reference documentation is maintained in upstream repositories and
115+
generated from YAML data files in `data/cli/`. A Hugo content adapter
116+
(`content/reference/cli/_content.gotmpl`) turns these data files into pages
117+
automatically. To update the CLI reference docs, refer to the corresponding
118+
repository:
117119

118120
- [docker/cli](https://github.com/docker/cli)
119121
- [docker/buildx](https://github.com/docker/buildx)
120122
- [docker/compose](https://github.com/docker/compose)
121123
- [docker/model-runner](https://github.com/docker/model-runner)
124+
- [docker/mcp-gateway](https://github.com/docker/mcp-gateway)
122125

123126
Feel free to raise an issue on this repository if you're not sure how to
124127
proceed, and we'll help out.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
8484

8585
### Search for and download an image
8686

87-
1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search.md) command:
87+
1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search/) command:
8888

8989
```console
9090
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
9999

100100
This output shows you information about relevant images available on Docker Hub.
101101

102-
2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull.md) command.
102+
2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull/) command.
103103

104104
```console
105105
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
127127

128128
### Learn about the image
129129

130-
1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls.md) command:
130+
1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls/) command:
131131

132132
```console
133133
docker image ls
@@ -146,7 +146,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
146146
>
147147
> The image size represented here reflects the uncompressed size of the image, not the download size of the layers.
148148
149-
2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history.md) command:
149+
2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history/) command:
150150

151151
```console
152152
docker image history docker/welcome-to-docker

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ the way you define and share multi-service applications.
283283
Related information:
284284
- [Compose overview](/manuals/compose/_index.md)
285285
- [Compose file reference](/reference/compose-file/_index.md)
286-
- [Compose CLI reference](/reference/cli/docker/compose/_index.md)
286+
- [Compose CLI reference](/reference/cli/docker/compose/)
287287

288288
## Next steps
289289

content/guides/angular/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ $ docker compose down
538538

539539
> [!NOTE]
540540
> For more information about Compose commands, see the [Compose CLI
541-
> reference](/reference/cli/docker/compose/_index.md).
541+
> reference](/reference/cli/docker/compose/).
542542
543543
---
544544

content/guides/angular/run-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Time: 1.529 s
107107

108108
> [!NOTE]
109109
> For more information about Compose commands, see the [Compose CLI
110-
> reference](/reference/cli/docker/compose/_index.md).
110+
> reference](/reference/cli/docker/compose/).
111111
112112
---
113113

content/guides/cpp/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ $ docker compose down
7676
```
7777

7878
For more information about Compose commands, see the [Compose CLI
79-
reference](/reference/cli/docker/compose/_index.md).
79+
reference](/reference/cli/docker/compose/).
8080

8181
## Summary
8282

content/guides/dotnet/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ $ docker compose down
210210
```
211211

212212
For more information about Compose commands, see the [Compose CLI
213-
reference](/reference/cli/docker/compose/_index.md).
213+
reference](/reference/cli/docker/compose/).
214214

215215
## Summary
216216

content/guides/genai-pdf-bot/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ application using Docker.
133133

134134
Related information:
135135

136-
- [docker init CLI reference](../../../reference/cli/docker/init.md)
136+
- [docker init CLI reference](/reference/cli/docker/init/)
137137

138138
## Next steps
139139

content/guides/java/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ $ docker compose down
317317
```
318318

319319
For more information about Compose commands, see the
320-
[Compose CLI reference](/reference/cli/docker/compose/_index.md).
320+
[Compose CLI reference](/reference/cli/docker/compose/).
321321

322322
## Summary
323323

content/guides/nodejs/containerize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ $ docker compose down
829829

830830
> [!NOTE]
831831
> For more information about Compose commands, see the [Compose CLI
832-
> reference](/reference/cli/docker/compose/_index.md).
832+
> reference](/reference/cli/docker/compose/).
833833

834834
---
835835

0 commit comments

Comments
 (0)