Skip to content

Commit 15bc461

Browse files
authored
Merge pull request #20667 from dvdksn/move-api-docs
chore: move api docs to /reference
2 parents b58ec55 + 2018844 commit 15bc461

Some content is hidden

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

82 files changed

+376
-334
lines changed

.htmltest.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ IgnoreAltEmpty: true
77
IgnoreEmptyHref: true
88
IgnoreDirectoryMissingTrailingSlash: true
99
IgnoreURLs:
10-
- "^/docker-hub/api/latest/.*$"
11-
- "^/engine/api/v.+/#.*$"
12-
- "^/glossary/.*$"
10+
- "^/reference/api/hub/.*$"
11+
- "^/reference/api/engine/v.+/#.*$"
1312
IgnoreDirs:
14-
- "engine/api"
1513
- "registry/configuration"
1614
- "compose/compose-file" # temporarily ignore until upstream is fixed
1715
CacheExpires: "6h"

content/desktop/faqs/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ export DOCKER_HOST=unix:///var/run/docker.sock
4949
Docker Desktop Windows users can connect to the Docker Engine through a **named pipe**: `npipe:////./pipe/docker_engine`, or **TCP socket** at this URL:
5050
`tcp://localhost:2375`.
5151

52-
For details, see [Docker Engine API](../../engine/api/index.md).
52+
For details, see [Docker Engine API](/reference/api/engine/_index.md).
5353

5454
### How do I connect from a container to a service on the host?
5555

content/docker-hub/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ GitHub and Bitbucket and push them to Docker Hub.
4040
* [Webhooks](webhooks.md): Trigger actions after a successful push
4141
to a repository to integrate Docker Hub with other services.
4242
* [Docker Hub CLI](https://github.com/docker/hub-tool#readme) tool (currently experimental) and an API that allows you to interact with Docker Hub.
43-
* Browse through the [Docker Hub API](/docker-hub/api/latest/) documentation to explore the supported endpoints.
43+
* Browse through the [Docker Hub API](/reference/api/hub/latest/) documentation to explore the supported endpoints.
4444
{{< /tab >}}
4545
{{< tab name="What administrative tasks can I perform in Docker Hub?" >}}
4646
* [Create and manage teams and organizations](orgs.md)

content/docker-hub/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The updated [Docker Subscription Service Agreement](https://www.docker.com/legal
139139

140140
When managing the content of your repositories, you can now filter the results based on the currentness of the tags and more easily identify your untagged images.
141141

142-
For Docker Hub API documentation, see [Docker Hub API Reference](api/latest.md#operation/GetNamespacesRepositoriesImages).
142+
For Docker Hub API documentation, see [Docker Hub API Reference](/reference/api/hub/latest.md#operation/GetNamespacesRepositoriesImages).
143143

144144
## 2021-04-13
145145

content/engine/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ application with:
5858
- A command line interface (CLI) client
5959
[`docker`](/reference/cli/docker/).
6060

61-
The CLI uses [Docker APIs](api/index.md) to control or interact with the Docker
61+
The CLI uses [Docker APIs](/reference/api/engine/_index.md) to control or interact with the Docker
6262
daemon through scripting or direct CLI commands. Many other Docker applications
6363
use the underlying API and CLI. The daemon creates and manages Docker objects,
6464
such as images, containers, networks, and volumes.

content/engine/api/_index.md

Lines changed: 0 additions & 166 deletions
This file was deleted.

content/engine/api/latest/index.html

Lines changed: 0 additions & 6 deletions
This file was deleted.

content/engine/api/v1.25.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

content/engine/api/v1.26.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

content/engine/api/v1.27.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)