Skip to content

Commit 3e6a00f

Browse files
authored
ENGDOCS-1273 (docker#16960)
* ENGDOCS-1273 * fix * fix broken link
1 parent f4258c0 commit 3e6a00f

File tree

5 files changed

+45
-51
lines changed

5 files changed

+45
-51
lines changed

_data/toc.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1779,10 +1779,10 @@ manuals:
17791779
section:
17801780
- path: /docker-hub/
17811781
title: Overview
1782+
- path: /docker-id/
1783+
title: Create an account
17821784
- path: /docker-hub/quickstart/
17831785
title: Quickstart
1784-
- path: /docker-id/
1785-
title: Docker ID accounts
17861786
- sectiontitle: Repositories
17871787
section:
17881788
- path: /docker-hub/repos/create/

docker-hub/quickstart.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ redirect_from:
7676
- /apidocs/overview/
7777
---
7878

79-
The following section contains step-by-step instructions on how to easily get started with Docker Hub.
79+
The following section contains step-by-step instructions on how to get started with Docker Hub.
8080

8181
### Step 1: Sign up for a Docker account
8282

83-
Let's start by creating a [Docker ID](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"}.
83+
Start by creating a [Docker ID](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"}.
8484

8585
A Docker ID grants you access to Docker Hub repositories and allows you to explore images that are available from the community and verified publishers. You'll also need a Docker ID to share images on Docker Hub.
8686

@@ -89,29 +89,24 @@ A Docker ID grants you access to Docker Hub repositories and allows you to explo
8989
To create a repository:
9090

9191
1. Sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}.
92-
2. Click **Create a Repository** on the Docker Hub welcome page.
92+
2. Select **Create a Repository** on the Docker Hub welcome page.
9393
3. Name it **<your-username>/my-private-repo**.
9494
4. Set the visibility to **Private**.
95+
5. Select **Create**.
9596

96-
![Create a repository](images/index-create-repo.png)
97-
98-
5. Click **Create**.
99-
100-
You've created your first repository. You should see:
101-
102-
![Repository created](images/index-repo-created.png)
97+
You've created your first repository.
10398

10499
### Step 3: Download and install Docker Desktop
105100

106-
You'll need to download Docker Desktop to build, push, and pull container images.
101+
You need to download Docker Desktop to build, push, and pull container images.
107102

108103
1. Download and install [Docker Desktop](../desktop/index.md).
109104

110-
2. Sign in to the Docker Desktop application using the Docker ID you've just created.
105+
2. Sign in to Docker Desktop using the Docker ID you created in step one.
111106

112107
### Step 4: Pull and run a container image from Docker Hub
113108

114-
1. Run `docker pull hello-world` to pull the image from Docker Hub. You should see output similar to:
109+
1. In your terminal, run `docker pull hello-world` to pull the image from Docker Hub. You should see output similar to:
115110

116111
```console
117112
$ docker pull hello-world
@@ -177,7 +172,7 @@ Docker image locally.
177172

178173
![Tag created](images/index-tag.png)
179174

180-
Congratulations! You've successfully:
175+
You've successfully:
181176

182177
- Signed up for a Docker account
183178
- Created your first repository

docker-hub/service-accounts.md

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ description: Docker Service accounts
33
keywords: Docker, service, accounts, Docker Hub
44
title: Service accounts
55
---
6+
> **Note**
7+
>
8+
> Service accounts requires a
9+
> [Docker Team, or Business subscription](../subscription/index.md).
610
711
A service account is a Docker ID used for automated management of container images or containerized applications. Service accounts are typically used in automated workflows, and don't share Docker IDs with the members in the organization. Common use cases for service accounts include mirroring content on Docker Hub, or tying in image pulls from your CI/CD process.
812

docker-hub/webhooks.md

+22-27
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
11
---
22
description: Docker Hub Webhooks
33
keywords: Docker, webhooks, hub, builds
4-
title: Docker Hub Webhooks
4+
title: Webhooks
55
---
66

77
You can use webhooks to cause an action in another service in response to a push event in the repository. Webhooks are POST requests sent to a URL you define in Docker Hub.
88

9-
Configure webhooks through the "Webhooks" tab on your Docker Hub repository:
9+
## Create a webhook
1010

11-
![Webhooks page](images/webhooks-empty.png)
11+
To create a webhook:
12+
1. In your chosen respository, select the **Webhooks** tabThen:
13+
2. Provide a name for the webhook
14+
3. Provide a destination webhook URL. This is where webhook POST requests are delivered.
15+
4. Select **Create**.
1216

13-
### Create Webhooks
17+
## View webhook delivery history
1418

15-
To create a webhook, visit the webhooks tab for your repository. Then:
16-
1. Provide a name for the webhooks
17-
2. Provide a destination webhook URL. This is where webhook POST requests will be delivered:
19+
To view the history of the webhook:
20+
1. Hover over your webhook under the **Current Webhooks section**.
21+
2. Select the **Menu options** icon.
22+
3. Select **View History**.
1823

19-
![Create webhooks](images/webhooks-create.png)
24+
You can then view the delivery history, and whether delivering the POST request was successful or not:
2025

21-
### View Webhook delivery history
26+
## Example webhook payload
2227

23-
You can view Webhook Delivery History by clicking on the submenu of the webhook and then clicking "View History"
24-
25-
![Webhook delivery history](images/webhooks-submenu.png)
26-
27-
You can then view the delivery history, and whether delivering the POST request was successful or failed:
28-
29-
![Webhooks History](images/webhooks-history.png)
30-
31-
### Example Webhook payload
32-
33-
Docker Hub Webhook payloads have the following payload JSON format:
28+
Webhook payloads have the following JSON format:
3429

3530
```json
3631
{
@@ -60,23 +55,23 @@ Docker Hub Webhook payloads have the following payload JSON format:
6055
}
6156
```
6257

63-
### Validate a webhook callback
58+
## Validate a webhook callback
6459

65-
To validate a callback in a webhook chain, you need to
60+
To validate a callback in a webhook chain, you need to:
6661

6762
1. Retrieve the `callback_url` value in the request's JSON payload.
6863
2. Send a POST request to this URL containing a valid JSON body.
6964

70-
> **Note**: A chain request is only considered complete once the last
71-
> callback has been validated.
72-
65+
> **Note**
66+
>
67+
> A chain request is only considered complete once the last callback is validated.
7368
74-
#### Callback JSON data
69+
### Callback JSON data
7570

7671
The following parameters are recognized in callback data:
7772

7873
* `state` (required): Accepted values are `success`, `failure`, and `error`.
79-
If the state isn't `success`, the Webhook chain is interrupted.
74+
If the state isn't `success`, the webhook chain is interrupted.
8075
* `description`: A string containing miscellaneous information that is
8176
available on Docker Hub. Maximum 255 characters.
8277
* `context`: A string containing the context of the operation. Can be retrieved

docker-id/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
22
description: Sign up for a Docker ID and log in
33
keywords: accounts, docker ID, billing, paid plans, support, Hub, Store, Forums, knowledge base, beta access, email, activation, verification
4-
title: Docker ID accounts
4+
title: Create an account
55
redirect_from:
66
- /docker-cloud/dockerid/
77
- /docker-hub/accounts/
88
---
99

10-
Your free Docker ID grants you access to Docker Hub repositories and some beta programs. All you need is an email address.
10+
All you need is an email address to create a Docker account. Once you've created your account with a unique Docker ID, you can access Docker Hub repositories and explore images that are available from the community and verified publishers.
1111

12-
## Register for a Docker ID
12+
Your Docker ID becomes your username for hosted Docker services, and [Docker forums](https://forums.docker.com/).
1313

14-
Your Docker ID becomes your user namespace for hosted Docker services, and becomes your username on the [Docker forums](https://forums.docker.com/). To create a new Docker ID:
14+
## Create a Docker ID
1515

1616
1. Go to the [Docker Hub signup page](https://hub.docker.com/signup/).
1717

18-
2. Enter a username that will become your Docker ID.
18+
2. Enter a username.
1919

20-
Your Docker ID must be between 4 and 30 characters long, and can only contain numbers and lowercase letters. *Once you create your Docker ID you can't reuse it in the future if you deactivate this account*.
20+
Your Docker ID must be between 4 and 30 characters long, and can only contain numbers and lowercase letters. Once you create your Docker ID you can't reuse it in the future if you deactivate this account.
2121

2222
3. Enter a unique, valid email address.
2323

24-
4. Enter a password that's at least 9 characters.
24+
4. Enter a password that's at least 9 characters long.
2525

2626
5. Complete the Captcha verification and then select **Sign up**.
2727

@@ -33,7 +33,7 @@ Your Docker ID becomes your user namespace for hosted Docker services, and becom
3333
>
3434
> You have limited actions available until you verify your email address.
3535
36-
## Log in
36+
## Sign in
3737

3838
Once you register and verify your Docker ID email address, you can sign in to [Docker Hub](https://hub.docker.com).
3939

0 commit comments

Comments
 (0)