Browse code

New screenshots and revisions to builds.md

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

Fred Lifton authored on 2014/07/10 08:43:39
Showing 5 changed files
... ...
@@ -77,13 +77,16 @@ Automated Build:
77 77
   <tbody>
78 78
     <tr>
79 79
       <td>1.</td>
80
-      <td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_settings.png"></td>
81
-      <td>Log in to Github.com, and visit your Repository page. Click on repository "Settings" on the right side of the page. You must have admin privileges to the repository in order to do this.</td>
80
+      <td><img src="/docker-hub/hub-images/gh_settings.png"></td>
81
+      <td>Log in to Github.com, and go to your Repository page. Click on "Settings" on
82
+      the right side of the page. You must have admin privileges to the repository in order to do this.</td>
82 83
     </tr>
83 84
     <tr>
84 85
       <td>2.</td>
85
-      <td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_service_hooks.png" alt="Service Hooks"></td>
86
-      <td>Click on "Webhooks & Services" on the left side of the page.</td></tr><tr><td>3.</td><td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_docker_service_hook.png" alt="Find the service labeled Docker"></td><td>Find the service labeled "Docker" and click on it.</td></tr><tr><td>4.</td><td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_service_hook_docker_activate.png" alt="Activate Service Hooks"></td>
86
+      <td><img src="/docker-hub/hub-images/gh_menu.png" alt="Webhooks & Services"></td>
87
+      <td>Click on "Webhooks & Services" on the left side of the page.</td></tr>
88
+      <tr><td>3.</td><td><img src="/docker-hub/hub-images/gh_service_hook.png" alt="Find the service labeled Docker"></td><td>Find the service labeled "Docker" and click on it.</td></tr>
89
+      <tr><td>4.</td><td><img src="/docker-hub/hub-images/gh_docker-service.png" alt="Activate Service Hooks"></td>
87 90
       <td>Make sure the "Active" checkbox is selected and click the "Update service" button to save your changes.</td>
88 91
     </tr>
89 92
   </tbody>
... ...
@@ -112,42 +115,42 @@ public or private Bitbucket repositories with a `Dockerfile`.
112 112
 
113 113
 ## The Dockerfile and Automated Builds
114 114
 
115
-During the build process, we copy the contents of your `Dockerfile`. We also
116
-add it to the [Docker Hub](https://hub.docker.com) for the Docker community (for public
117
-repos) or approved team members/orgs (for private repos) to see on the repository page
118
-(if your repo is public).
115
+During the build process, Docker will copy the contents of your `Dockerfile`. It will
116
+also add it to the [Docker Hub](https://hub.docker.com) for the Docker community (for
117
+public repos) or approved team members/orgs (for private repos) to see on the repository
118
+page.
119 119
 
120 120
 ## README.md
121 121
 
122 122
 If you have a `README.md` file in your repository, it will be used as the
123
-repository's full description.
123
+repository's full description.The build process will look for a
124
+`README.md` in the same directory as your `Dockerfile`.
124 125
 
125 126
 > **Warning:**
126 127
 > If you change the full description after a build, it will be
127 128
 > rewritten the next time the Automated Build has been built. To make changes,
128
-> modify the `README.md` from the Git repository. The build process will look for a
129
-> `README.md` in the same directory as your `Dockerfile`.
129
+> modify the `README.md` from the Git repository.
130 130
 
131 131
 ### Build triggers
132 132
 
133 133
 If you need a way to trigger Automated Builds outside of GitHub
134 134
 or Bitbucket, you can set up a build trigger. When you turn on the build
135 135
 trigger for an Automated Build, it will give you a URL to which you can
136
-send POST requests. This will trigger the Automated Build, which
137
-is similar to GitHub webhooks.
136
+send POST requests. This will trigger the Automated Build, much as with a GitHub webhook.
138 137
 
139
-Build triggers are available under the Settings tab of each Automated Build.
138
+Build triggers are available under the Settings menu of each Automated Build repo on the
139
+Docker Hub.
140 140
 
141 141
 > **Note:** 
142 142
 > You can only trigger one build at a time and no more than one
143
-> every five minutes. If you have a build already pending, or if you already
143
+> every five minutes. If you already have a build pending, or if you
144 144
 > recently submitted a build request, those requests *will be ignored*.
145
-> You can find the logs of last 10 triggers on the settings page to verify
146
-> if everything is working correctly.
145
+> To verify everything is working correctly, check the logs of last ten triggers on the
146
+settings page .
147 147
 
148 148
 ### Webhooks
149 149
 
150
-Also available for Automated Builds are Webhooks. Webhooks can be called
150
+Automated Builds also include a Webhooks feature. Webhooks can be called
151 151
 after a successful repository push is made.
152 152
 
153 153
 The webhook call will generate a HTTP POST with the following JSON
... ...
@@ -184,24 +187,23 @@ payload:
184 184
 }
185 185
 ```
186 186
 
187
-Webhooks are available under the Settings tab of each Automated
188
-Build.
187
+Webhooks are available under the Settings menu of each Automated
188
+Build's repo.
189 189
 
190
-> **Note:** If you want to test your webhook out then we recommend using
190
+> **Note:** If you want to test your webhook out we recommend using
191 191
 > a tool like [requestb.in](http://requestb.in/).
192 192
 
193 193
 
194 194
 ### Repository links
195 195
 
196 196
 Repository links are a way to associate one Automated Build with another. If one
197
-gets updated, linking system also triggers a build for the other Automated Build.
198
-This makes it easy to keep your Automated Builds up to date.
197
+gets updated,the linking system triggers a rebuild for the other Automated Build.
198
+This makes it easy to keep all your Automated Builds up to date.
199 199
 
200
-To add a link, go to the settings page of an Automated Build and click on
201
-*Repository Links*. Then enter the name of the repository that you want have
202
-linked.
200
+To add a link, go to the repo for the Automated Build you want to link to and click on
201
+*Repository Links* under the Settings menu at right. Then, enter the name of the repository that you want have linked.
203 202
 
204 203
 > **Warning:**
205 204
 > You can add more than one repository link, however, you should
206
-> be very careful. Creating a two way relationship between Automated Builds will
207
-> cause a never ending build loop.
205
+> do so very carefully. Creating a two way relationship between Automated Builds will
206
+> cause an endless build loop.
208 207
new file mode 100644
209 208
Binary files /dev/null and b/docs/sources/docker-hub/hub-images/gh_docker-service.png differ
210 209
new file mode 100644
211 210
Binary files /dev/null and b/docs/sources/docker-hub/hub-images/gh_menu.png differ
212 211
new file mode 100644
213 212
Binary files /dev/null and b/docs/sources/docker-hub/hub-images/gh_service_hook.png differ
214 213
new file mode 100644
215 214
Binary files /dev/null and b/docs/sources/docker-hub/hub-images/gh_settings.png differ