Skip to content

Commit d969391

Browse files
committedAug 22, 2024
chore: move glossary to /reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent eb37a78 commit d969391

File tree

17 files changed

+26
-27
lines changed

17 files changed

+26
-27
lines changed
 

‎.htmltest.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ IgnoreAltEmpty: true
77
IgnoreEmptyHref: true
88
IgnoreDirectoryMissingTrailingSlash: true
99
IgnoreURLs:
10-
- "^/reference/api/docker-hub/.*$"
10+
- "^/reference/api/hub/.*$"
1111
- "^/engine/api/v.+/#.*$"
12-
- "^/glossary/.*$"
1312
IgnoreDirs:
1413
- "engine/api"
1514
- "registry/configuration"

‎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](/reference/api/docker-hub/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](/reference/api/docker-hub/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/reference/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ grid_apis:
3737
- title: Docker Hub API
3838
description: API to interact with Docker Hub.
3939
icon: communities
40-
link: /reference/api/docker-hub/latest/
40+
link: /reference/api/hub/latest/
4141
- title: DVP Data API
4242
description: API for Docker Verified Publishers to fetch analytics data.
4343
icon: area_chart
44-
link: /reference/api/docker-hub/dvp/
44+
link: /reference/api/hub/dvp/
4545
---
4646

4747
This section includes the reference documentation for the Docker platform's

‎content/reference/api/docker-hub/deprecated.md renamed to ‎content/reference/api/hub/deprecated.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ If you want to continue using the Docker Hub API in your current applications, u
2222

2323
| **OLD** | **NEW** |
2424
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25-
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/docker-hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
26-
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/docker-hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
27-
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/docker-hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
28-
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/docker-hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
29-
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/docker-hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
30-
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/docker-hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
25+
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
26+
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
27+
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
28+
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
29+
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
30+
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |

‎content/reference/api/docker-hub/dvp.yaml renamed to ‎content/reference/api/hub/dvp.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,5 +690,5 @@ components:
690690
description: |
691691
JWT Bearer Authentication is required to access the Docker DVP Data API.
692692
693-
This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/reference/api/docker-hub/#tag/authentication)
693+
This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/reference/api/hub/#tag/authentication)
694694
x-displayName: Docker Hub Authentication

‎content/glossary.md renamed to ‎content/reference/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ layout: glossary
66
notoc: true
77
aliases:
88
- /engine/reference/glossary/
9-
- /reference/glossary/
9+
- /glossary/
1010
---
1111

1212
<!--

‎content/security/faqs/single-sign-on/users-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Docker SSO provides Just-in-Time (JIT) provisioning by default, with an option t
6363

6464
[SCIM](../../../security/for-admins/provisioning/scim/) is available to provide full synchronization with users and groups. When you auto-provision users with SCIM, the recommended configuration is to disable JIT so that all auto-provisioning is handled by SCIM.
6565

66-
Additionally, you can use the [Docker Hub API](/reference/api/docker-hub/latest/) to complete this process.
66+
Additionally, you can use the [Docker Hub API](/reference/api/hub/latest/) to complete this process.
6767

6868
### How does disabling Just-in-Time provisioning impact user sign-in?
6969

‎content/security/for-admins/provisioning/scim.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following table lists the supported attributes. Note that your attribute map
3131
| name.familyName | User’s surname |
3232
| active | Indicates if a user is enabled or disabled. Can be set to false to de-provision the user. |
3333

34-
For additional details about supported attributes and SCIM, see [Docker Hub API SCIM reference](/reference/api/docker-hub/latest/#tag/scim).
34+
For additional details about supported attributes and SCIM, see [Docker Hub API SCIM reference](/reference/api/hub/latest/#tag/scim).
3535

3636
> [!IMPORTANT]
3737
>

‎content/trusted-content/insights-analytics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You can download extension CSV reports from the **Insights and analytics** dashb
6060
## Exporting analytics data
6161

6262
You can export the analytics data either from the web dashboard, or using the
63-
[DVP Data API](/reference/api/docker-hub/dvp.md). All members of an organization have access to the analytics data.
63+
[DVP Data API](/reference/api/hub/dvp.md). All members of an organization have access to the analytics data.
6464

6565
The data is available as a downloadable CSV file, in a weekly (Monday through
6666
Sunday) or monthly format. Monthly data is available from the first day of the
@@ -88,7 +88,7 @@ Export usage data for your organization's images using the Docker Hub website by
8888

8989
The HTTP API endpoints are available at:
9090
`https://hub.docker.com/api/publisher/analytics/v1`. Learn how to export data
91-
using the API in the [DVP Data API documentation](/reference/api/docker-hub/dvp.md).
91+
using the API in the [DVP Data API documentation](/reference/api/hub/dvp.md).
9292

9393
## Data points
9494

‎data/redirects.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@
101101
"/desktop/windows/wsl/":
102102
# Link used by Docker Desktop to refer users on how to activate WSL 2
103103
- /go/wsl2/
104-
"/reference/api/docker-hub/latest/":
104+
"/reference/api/hub/latest/":
105105
- /docker-hub/api/latest/
106-
"/reference/api/docker-hub/dvp/":
106+
"/reference/api/hub/dvp/":
107107
- /docker-hub/api/dvp/
108108

109109
# feedback

‎data/toc.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -980,11 +980,11 @@ Reference:
980980
- sectiontitle: Docker Hub API
981981
section:
982982
- title: Docker Hub API
983-
path: /reference/api/docker-hub/latest/
983+
path: /reference/api/hub/latest/
984984
- title: DVP Data API
985-
path: /reference/api/docker-hub/dvp/
985+
path: /reference/api/hub/dvp/
986986
- title: Deprecated API
987-
path: /reference/api/docker-hub/deprecated/
987+
path: /reference/api/hub/deprecated/
988988
- sectiontitle: Docker Extension SDK API
989989
section:
990990
- path: /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/
@@ -1075,7 +1075,7 @@ Reference:
10751075
title: Compose Develop Specification
10761076
- path: /reference/compose-file/legacy-versions/
10771077
title: Legacy versions
1078-
- path: /glossary/
1078+
- path: /reference/glossary/
10791079
title: Glossary
10801080
- sectiontitle: Samples
10811081
section:

‎layouts/_default/hub-api-baseof.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<!-- favicon -->
1212
{{ partialCached "favicon.html" "favicon" }}
1313
<!-- make the latest API version the canonical page as that's what we want users to be using mostly -->
14-
<link rel="canonical" href="{{ "/reference/api/docker-hub/latest/" | relURL }}" />
14+
<link rel="canonical" href="{{ "/reference/api/hub/latest/" | relURL }}" />
1515
<style>
1616
body {
1717
margin: 0;
@@ -26,7 +26,7 @@
2626
</head>
2727

2828
<body>
29-
<redoc spec-url="/reference/api/docker-hub/{{ .File.BaseFileName }}.yaml" class="hub-api"></redoc>
29+
<redoc spec-url="/reference/api/hub/{{ .File.BaseFileName }}.yaml" class="hub-api"></redoc>
3030
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
3131
</body>
3232

‎layouts/shortcodes/admin-org-onboarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before you start to onboard your organization, ensure that you:
1616
>
1717
> When purchasing a self-serve subscription, the on-screen instructions guide you through creating an organization. If you have purchased a subscription through Docker Sales and you have not yet created an organization, see [Create an organization](/admin/organization/orgs).
1818
19-
- Familiarize yourself with Docker concepts and terminology in the [glossary](/glossary/) and [FAQs](/faq/admin/general-faqs/).
19+
- Familiarize yourself with Docker concepts and terminology in the [glossary](/reference/glossary/) and [FAQs](/faq/admin/general-faqs/).
2020

2121
## Step 1: Identify your Docker users and their Docker accounts
2222

0 commit comments

Comments
 (0)
Please sign in to comment.