Browse code

Add a userguide to cover the uses of Hub before creating new repositories

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Sven Dowideit authored on 2015/05/04 14:25:47
Showing 10 changed files
... ...
@@ -75,7 +75,8 @@ pages:
75 75
 # Docker Hub docs:
76 76
 - ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ]
77 77
 - ['docker-hub/accounts.md', 'Docker Hub', 'Accounts']
78
-- ['docker-hub/repos.md', 'Docker Hub', 'Repositories']
78
+- ['docker-hub/userguide.md', 'Docker Hub', 'User Guide']
79
+- ['docker-hub/repos.md', 'Docker Hub', 'Your Repositories']
79 80
 - ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds']
80 81
 - ['docker-hub/official_repos.md', 'Docker Hub', 'Official Repositories']
81 82
 
82 83
new file mode 100644
83 84
Binary files /dev/null and b/docs/sources/docker-hub/hub-images/dashboard.png differ
84 85
Binary files a/docs/sources/docker-hub/hub-images/groups.png and b/docs/sources/docker-hub/hub-images/groups.png differ
85 86
Binary files a/docs/sources/docker-hub/hub-images/hub.png and b/docs/sources/docker-hub/hub-images/hub.png differ
86 87
Binary files a/docs/sources/docker-hub/hub-images/invite.png and b/docs/sources/docker-hub/hub-images/invite.png differ
87 88
Binary files a/docs/sources/docker-hub/hub-images/orgs.png and b/docs/sources/docker-hub/hub-images/orgs.png differ
88 89
Binary files a/docs/sources/docker-hub/hub-images/repos.png and b/docs/sources/docker-hub/hub-images/repos.png differ
... ...
@@ -4,20 +4,29 @@ page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub
4 4
 
5 5
 # Docker Hub
6 6
 
7
+The [Docker Hub](https://hub.docker.com) provides a cloud-based platform service
8
+for distributed applications, including container image distribution and change
9
+management, user and team collaboration, and lifecycle workflow automation.
10
+
7 11
 ![DockerHub](/docker-hub/hub-images/hub.png)
8 12
 
9
-## [Accounts](accounts/)
13
+## [Finding and pulling images](./userguide.md)
14
+
15
+Find out how to [use the Docker Hub](./userguide.md) to find and pull Docker
16
+images to run or build upon.
17
+
18
+## [Accounts](./accounts.md)
10 19
 
11
-[Learn how to create](accounts/) a [Docker Hub](https://hub.docker.com)
20
+[Learn how to create](./accounts.md) a Docker Hub
12 21
 account and manage your organizations and groups.
13 22
 
14
-## [Repositories](repos/)
23
+## [Your Repositories](./repos.md)
15 24
 
16 25
 Find out how to share your Docker images in [Docker Hub
17
-repositories](repos/) and how to store and manage private images.
26
+repositories](./repos.md) and how to store and manage private images.
18 27
 
19
-## [Automated builds](builds/)
28
+## [Automated builds](./builds.md)
20 29
 
21 30
 Learn how to automate your build and deploy pipeline with [Automated
22
-Builds](builds/)
31
+Builds](./builds.md)
23 32
 
... ...
@@ -1,42 +1,37 @@
1
-page_title: Repositories and images on Docker Hub
2
-page_description: Repositories and images on Docker Hub
1
+page_title: Your Repositories on Docker Hub
2
+page_description: Your Repositories on Docker Hub
3 3
 page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation
4 4
 
5
-# Repositories and images on Docker Hub
5
+# Your Hub repositories
6 6
 
7
-![repositories](/docker-hub/hub-images/repos.png)
8
-
9
-## Searching for repositories and images
10
-
11
-You can `search` for all the publicly available repositories and images using
12
-Docker.
13
-
14
-    $ docker search ubuntu
7
+Docker Hub repositories make it possible for you to share images with co-workers,
8
+customers or the Docker community at large. If you're building your images internally,
9
+either on your own Docker daemon, or using your own Continuous integration services,
10
+you can push them to a Docker Hub repository that you add to your Docker Hub user or
11
+organization account.
15 12
 
16
-This will show you a list of the currently available repositories on the
17
-Docker Hub which match the provided keyword.
13
+Alternativly, if the source code for your Docker image is on GitHub or Bitbucket,
14
+you can use an "Automated build" repository, which is built by the Docker Hub
15
+services. See the [automated builds documentation](./builds.md) to read about
16
+the extra functionality provided by those services.
18 17
 
19
-If a repository is private it won't be listed on the repository search
20
-results. To see repository statuses, you can look at your [profile
21
-page](https://hub.docker.com) on [Docker Hub](https://hub.docker.com).
22
-
23
-## Repositories
18
+![repositories](/docker-hub/hub-images/repos.png)
24 19
 
25 20
 Your Docker Hub repositories have a number of useful features.
26 21
 
27
-### Stars
22
+## Stars
28 23
 
29 24
 Your repositories can be starred and you can star repositories in
30 25
 return. Stars are a way to show that you like a repository. They are
31 26
 also an easy way of bookmarking your favorites.
32 27
 
33
-### Comments
28
+## Comments
34 29
 
35 30
 You can interact with other members of the Docker community and maintainers by
36 31
 leaving comments on repositories. If you find any comments that are not
37 32
 appropriate, you can flag them for review.
38 33
 
39
-### Collaborators and their role
34
+## Collaborators and their role
40 35
 
41 36
 A collaborator is someone you want to give access to a private
42 37
 repository. Once designated, they can `push` and `pull` to your
... ...
@@ -48,24 +43,9 @@ private to public.
48 48
 > A collaborator cannot add other collaborators. Only the owner of
49 49
 > the repository has administrative access.
50 50
 
51
-You can also collaborate on Docker Hub with organizations and groups.
52
-You can read more about that [here](accounts/).
53
-
54
-## Official Repositories
55
-
56
-The Docker Hub contains a number of [Official
57
-Repositories](http://registry.hub.docker.com/official). These are
58
-certified repositories from vendors and contributors to Docker. They
59
-contain Docker images from vendors like Canonical, Oracle, and Red Hat
60
-that you can use to build applications and services.
61
-
62
-If you use Official Repositories you know you're using a supported,
63
-optimized and up-to-date image to power your applications.
64
-
65
-> **Note:**
66
-> If you would like to contribute an Official Repository for your
67
-> organization, see [Official Repositories on Docker
68
-> Hub](/docker-hub/official_repos) for more information.
51
+You can also assign more granular collaborator rights ("Read", "Write", or "Admin")
52
+on Docker Hub by using organizations and groups. For more information
53
+see the [accounts documentation](accounts/).
69 54
 
70 55
 ## Private repositories
71 56
 
... ...
@@ -100,8 +80,15 @@ Hub](https://registry.hub.docker.com/plans/) plan.
100 100
 
101 101
 ## Webhooks
102 102
 
103
-You can configure webhooks for your repositories on the Repository
104
-Settings page. A webhook is called only after a successful `push` is
103
+A webhook is an HTTP call-back triggered by a specific event.
104
+You can use a Hub repository webhook to notify people, services, and other
105
+applications after a new image is pushed to your repository (this also happens
106
+for Automated builds). For example, you can trigger an automated test or
107
+deployment to happen as soon as the image is available.
108
+
109
+To get started adding webhooks, go to the desired repository in the Hub,
110
+and click "Webhooks" under the "Settings" box.
111
+A webhook is called only after a successful `push` is
105 112
 made. The webhook calls are HTTP POST requests with a JSON payload
106 113
 similar to the example shown below.
107 114
 
... ...
@@ -137,13 +124,9 @@ similar to the example shown below.
137 137
 }
138 138
 ```
139 139
 
140
-Webhooks allow you to notify people, services and other applications of
141
-new updates to your images and repositories. To get started adding webhooks,
142
-go to the desired repository in the Hub, and click "Webhooks" under the "Settings"
143
-box.
140
+<TODO: does it tell you what tag was updated?>
144 141
 
145
-> **Note:** For testing, you can try an HTTP request tool like
146
-> [requestb.in](http://requestb.in/).
142
+For testing, you can try an HTTP request tool like [requestb.in](http://requestb.in/).
147 143
 
148 144
 > **Note**: The Docker Hub servers are currently in the IP range
149 145
 > `162.242.195.64 - 162.242.195.127`, so you can restrict your webhooks to
... ...
@@ -161,7 +144,7 @@ in your chain.
161 161
 The first webhook in a chain will be called after a successful push. Subsequent
162 162
 URLs will be contacted after the callback has been validated.
163 163
 
164
-#### Validating a callback
164
+### Validating a callback
165 165
 
166 166
 In order to validate a callback in a webhook chain, you need to
167 167
 
... ...
@@ -195,3 +178,10 @@ The following parameters are recognized in callback data:
195 195
       "context": "Continuous integration by Acme CI",
196 196
       "target_url": "http://ci.acme.com/results/afd339c1c3d27"
197 197
     }
198
+
199
+## Mark as unlisted
200
+
201
+By marking a repository as unlisted, you can create a publically pullable repository
202
+which will not be in the Hub or commandline search. This allows you to have a limited
203
+release, but does not restrict access to anyone that is told, or guesses the repository
204
+name.
198 205
new file mode 100644
... ...
@@ -0,0 +1,57 @@
0
+page_title: Docker Hub user guide
1
+page_description: Docker Hub user guide
2
+page_keywords: Docker, docker, registry, Docker Hub, docs, documentation
3
+
4
+# Using the Docker Hub
5
+
6
+Docker Hub is used to find and pull Docker images to run or build upon, and to
7
+distribute and build images for other users to use.
8
+
9
+![your profile](/docker-hub/hub-images/dashboard.png)
10
+
11
+## Finding repositories and images
12
+
13
+There are two ways you can search for public repositories and images available
14
+on the Docker Hub. You can use the "Search" tool on the Docker Hub website, or
15
+you can `search` for all the repositories and images using the Docker commandline
16
+tool:
17
+
18
+    $ docker search ubuntu
19
+
20
+Both will show you a list of the currently available public repositories on the
21
+Docker Hub which match the provided keyword.
22
+
23
+If a repository is private or marked as unlisted, it won't be in the repository
24
+search results. To see all the repositories you have access to and their statuses,
25
+you can look at your profile page on [Docker Hub](https://hub.docker.com).
26
+
27
+## Pulling, running and building images
28
+
29
+You can find more information on [working with Docker images](../userguide/dockerimages.md).
30
+
31
+## Official Repositories
32
+
33
+The Docker Hub contains a number of [Official
34
+Repositories](http://registry.hub.docker.com/official). These are
35
+certified repositories from vendors and contributors to Docker. They
36
+contain Docker images from vendors like Canonical, Oracle, and Red Hat
37
+that you can use to build applications and services.
38
+
39
+If you use Official Repositories you know you're using an optimized and
40
+up-to-date image to power your applications.
41
+
42
+> **Note:**
43
+> If you would like to contribute an Official Repository for your
44
+> organization, see [Official Repositories on Docker
45
+> Hub](/docker-hub/official_repos) for more information.
46
+
47
+## Building and shipping your own repositories and images
48
+
49
+The Docker Hub provides you and your team with a place to build and ship Docker images.
50
+
51
+Collections of Docker images are managed using repositories - 
52
+
53
+You can configure two types of repositories to manage on the Docker Hub:
54
+[Repositories](./repos.md), which allow you to push images to the Hub from your local Docker daemon,
55
+and [Automated Builds](./builds.md), which allow you to configure GitHub or Bitbucket to
56
+trigger the Hub to rebuild repositories when changes are made to the repository.