Reword "hooks" references to "webhooks"

gjtorikian · gjtorikian · commit a5f09d75fcfd · 2014-01-31T11:56:01.000-08:00
diff --git a/content/v3/repos/hooks.md b/content/v3/repos/hooks.md
@@ -1,52 +1,52 @@
 ---
-title: Hooks | GitHub API
+title: Webhooks | GitHub API
 ---
 
-# Hooks
+# Webhooks
 
 * TOC
 {:toc}
 
-The Repository Hooks API allows repository admins to manage the post-receive 
-hooks for a repository.  Hooks can be managed using the [JSON HTTP API](#json-http)
+The Repository Webhooks API allows repository admins to manage the post-receive
+hooks for a repository.  Webhooks can be managed using the [JSON HTTP API](#json-http)
 and the [PubSubHubbub API](#pubsubhubbub).
 
-Each hook can be configured for a specific [service](#services) and one or 
+Each hook can be configured for a specific [service](#services) and one or
 more [events](#events), regardless of the API used to do so.
 
 ## Services
 
 A service is basically the name used to refer to a hook that has configuration
 settings, a list of available events, and default events.
 
-> For instance, the 
+> For instance, the
 [email](https://github.com/github/github-services/blob/master/lib/services/email.rb)
-service is a built-in GitHub service that will send event [payloads](#payloads) 
-to, at most, two email addresses.  It will trigger for the `push` 
+service is a built-in GitHub service that will send event [payloads](#payloads)
+to, at most, two email addresses.  It will trigger for the `push`
 event by default and supports the `public` event type as well.
 
 A number of services have been integrated through the open source
-[github-services](https://github.com/github/github-services) project.  When 
-creating a [hook](#create-a-hook), the `:name` parameter must refer to one of 
-these services.  A generic 
-[Web](https://github.com/github/github-services/blob/master/lib/services/web.rb) 
-service is available that can configured to trigger for any of the available 
+[github-services](https://github.com/github/github-services) project.  When
+creating a [hook](#create-a-hook), the `:name` parameter must refer to one of
+these services.  A generic
+[Web](https://github.com/github/github-services/blob/master/lib/services/web.rb)
+service is available that can configured to trigger for any of the available
 [events](#events).
 
 Documentation for all available service hooks can be found in the
 [docs directory](https://github.com/github/github-services/tree/master/docs)
 of the github-services repository.  A JSON representation of their names,
-default events, supported events, and configuration options can be seen 
+default events, supported events, and configuration options can be seen
 at [api.github.com/hooks](https://api.github.com/hooks).
 
 
-## Events 
+## Events
 
-Active hooks can be configured to trigger for one or more service supported 
-events. In other words, the service must support listening for the event you 
+Active hooks can be configured to trigger for one or more service supported
+events. In other words, the service must support listening for the event you
 want to trigger.
 
-For example, the 
+For example, the
 [Web](https://github.com/github/github-services/blob/master/lib/services/web.rb)
 service listens for all events, while the
 [IRC](https://github.com/github/github-services/blob/master/lib/services/irc.rb)
@@ -80,13 +80,13 @@ Name | Description
 
 The payloads for all hooks mirror [the payloads for the Event
 types](/v3/activity/events/types/), with the exception of [the original `push`
-event](http://help.github.com/post-receive-hooks/), 
+event](http://help.github.com/post-receive-hooks/),
 which has a more detailed payload.
 
 
 ## JSON HTTP
 
-The JSON HTTP API follows the same conventions as the rest of the 
+The JSON HTTP API follows the same conventions as the rest of the
 [GitHub API](http://developer.github.com/v3/).
 
 ### List
@@ -113,7 +113,7 @@ The JSON HTTP API follows the same conventions as the rest of the
 
 #### Parameter
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `name`|`string` | **Required**. The name of the service that is being called. (See [/hooks](https://api.github.com/hooks) for the list of valid hook names.)
 `config`|`hash` | **Required**. Key/value pairs to provide settings for this hook.  These settings vary between the services and are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false.  Any JSON `true`/`false` values will be converted automatically.
@@ -125,7 +125,7 @@ Name | Type | Description
 The ["web" service hook](https://github.com/github/github-services/blob/master/lib/services/web.rb#L4-11)
 takes these fields in the `config`:
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `url`|`string` | **Required**. The URL to which the payloads will be delivered.
 `content_type`|`string` | The media type used to serialize the payloads. Supported values: `json` and `form`. Default: `form`.
@@ -251,7 +251,7 @@ exists, it will be modified according to the request.
 
 #### Parameters
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 ``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`.
 ``hub.topic``|`string` |**Required**.  The URI of the GitHub repository to subscribe to.  The path must be in the format of `/:owner/:repo/events/:event`.
diff --git a/content/v3/troubleshooting.md b/content/v3/troubleshooting.md
@@ -30,7 +30,7 @@ in order to get more results.
 It's important to *not* try and guess the format of the pagination URL. Not every
 API call uses the same structure. Instead, extract the pagination information from
 [the Link Header](/v3/#pagination), which is sent with every request.
-  
+
 ## Can I get my rate limits bumped?
 
 The GitHub API has a pretty lenient quota for rate limits, for your enjoyment and
@@ -43,7 +43,7 @@ In certain exceptional cases, we may temporarily bump your rate limit higher. Yo
 should be prepared to answer technical questions about your goal and your planned usage of the API. We may still choose not to bump your limit if we feel that you can achieve your wildest
 dreams with the current rate limit (but don't worry, we'll help you out).
 
-## Why can't my server with SSL receive WebHooks?
+## Why can't my server with SSL receive Webhooks?
 
 When we send events to your server, we attempt to negotiate either SSL version 2 or 3.
 If your server requires a specific SSL version and does not support SSL negotiation,
diff --git a/content/webhooks/configuring/index.md b/content/webhooks/configuring/index.md
@@ -1,15 +1,15 @@
 ---
 title: Configuring Your Server | GitHub API
-layout: hooks
+layout: webhooks
 ---
 
 # Configuring Your Server
 
 * TOC
 {:toc}
 
-Now that our hook is ready to deliver messages, we'll set up a basic Sinatra server 
-to handle incoming payloads. 
+Now that our hook is ready to deliver messages, we'll set up a basic Sinatra server
+to handle incoming payloads.
 
 Recall that we specifically set our webhook URL to `http://localhost:4567/payload`.
 Since we're developing locally, we'll need to expose our local development environment
@@ -34,7 +34,7 @@ on the command line. You should see a line that looks something like this:
 Copy that funky `*.ngrok.com` URL! We're now going to go *back* to the Payload
 URL and pasting this server into that field. It should look something like `http://7e9ea9dc.ngrok.com/payload`.
 
-By doing this, we've set ourselves up to expose our localhost at path `/payload` 
+By doing this, we've set ourselves up to expose our localhost at path `/payload`
 to the Internet.
 
 ## Writing the server
@@ -44,13 +44,13 @@ because that's where we told GitHub our webhook URL was. Since ngrok is exposing
 our local environment, we don't need to set up a real server someone online, and
 can happily test out our code locally.
 
-Let's set up a little Sinatra app to do something with the information. Our initial 
+Let's set up a little Sinatra app to do something with the information. Our initial
 setup might look something like this:
 
     #!ruby
     require 'sinatra'
     require 'json'
-    
+
     post '/payload' do
       push = JSON.parse(params[:payload])
       puts "I got some JSON: #{push.inspect}"
@@ -65,7 +65,7 @@ and create a new Issue on the repository you're testing with. Once you create
 it, switch back to your terminal. You should see something like this in your output:
 
     #!bash
-    [adding-hooks]* ~/github/platform-samples/hooks/ruby/configuring-your-server $ ruby server.rb 
+    [adding-hooks]* ~/github/platform-samples/hooks/ruby/configuring-your-server $ ruby server.rb
     == Sinatra/1.4.4 has taken the stage on 4567 for development with backup from Thin
     >> Thin web server (v1.5.1 codename Straight Razor)
     >> Maximum connections set to 1024
diff --git a/content/webhooks/creating/index.md b/content/webhooks/creating/index.md
@@ -1,24 +1,24 @@
 ---
-title: Creating Hooks | GitHub API
-layout: hooks
+title: Creating Webhooks | GitHub API
+layout: webhooks
 ---
 
-# Creating Hooks
+# Creating Webhooks
 
 * TOC
 {:toc}
 
-At their core, Hooks are post-receive messages that deliver a payload of 
-information about activity in a repository. Hooks can trigger across several 
+At their core, webhooks are events generated by GitHub that deliver a payload of
+information about activity in a repository. Webhooks can trigger across several
 different actions. For example, you can fire a payload of information any time
 a commit is made, a repository is forked, or an issue is created.
 
-In this tutorial, our hook will be responsible for listing out how popular our 
+In this tutorial, our hook will be responsible for listing out how popular our
 repository is, based on the number of Issues it receives per day.
 
 Creating a hook is a two-step process. You'll first need to set up how you want
 your hook to behave through GitHub--what events should it listen to, and what
-fields (if any) should be passed along. After that, you'll manage how to receive 
+fields (if any) should be passed along. After that, you'll manage how to receive
 the payload on your server.
 
 ## Setting up a Hook
@@ -34,11 +34,11 @@ can take advantage of. We'll go through each of these below.
 This is the server endpoint that will receive the hook payload.
 
 Since we're developing locally for our tutorial, let's set it to `http://localhost:4567/payload`.
-We'll explain why in the [Configuring Your Server](/hooks/configuring/) docs. 
+We'll explain why in the [Configuring Your Server](/hooks/configuring/) docs.
 
 ## Payload version
 
-Webhooks can deliver various [media types](/v3/media/) as defined by the GitHub API. 
+Webhooks can deliver various [media types](/v3/media/) as defined by the GitHub API.
 Choose the one that best fits your needs. For this tutorial, the default format is fine.
 
 ## Events
@@ -51,7 +51,7 @@ A full list of hooks, and when they execute, can be found in [the hooks API][hoo
 Since our hook is dealing with Issues in a repository, we'll click on **Issues**,
 and toggle the options there.
 
-When you're finished, click on **Add webhook**. Phew! Now that the hook is created, 
+When you're finished, click on **Add webhook**. Phew! Now that the hook is created,
 it's time to set up our local server to test the webhook. Head on over to
 [Configuring Your Server](/hooks/configuring/) to learn how to do that.
 
diff --git a/content/webhooks/index.md b/content/webhooks/index.md
@@ -1,6 +1,6 @@
 ---
-title: Hooks | GitHub API
-layout: hooks
+title: Webhooks | GitHub API
+layout: webhooks
 ---
 
 Every GitHub repository has the option to communicate with a web server whenever
diff --git a/content/webhooks/testing/index.md b/content/webhooks/testing/index.md
@@ -1,15 +1,15 @@
 ---
-title: Testing Hooks | GitHub API
-layout: hooks
+title: Testing Webhooks | GitHub API
+layout: webhooks
 ---
 
-# Testing Hooks
+# Testing Webhooks
 
 * TOC
 {:toc}
 
 Now that you've [configured your local server](/hooks/configuring/), you might
-be interested in pushing your code to the limits. To that end, GitHub's webhooks 
+be interested in pushing your code to the limits. To that end, GitHub's webhooks
 view provides some tooling for testing your deployed payloads.
 
 
@@ -35,6 +35,6 @@ It also includes details about the JSON payload.
 
 ## Response
 
-The response tab lists how your server replied once it received the payload from 
+The response tab lists how your server replied once it received the payload from
 GitHub. This includes the status code, the headers, and any additional data
 within the response body.
diff --git a/layouts/webhooks.html b/layouts/webhooks.html
@@ -1,16 +1,16 @@
 <%= render 'head' %>
 
-<body class="hooks">
+<body class="webhooks">
   <%= render 'header' %>
-  
+
   <div class="sub-nav">
-    <h2><a href="/v3/">Hooks</a></h2>
-    
+    <h2><a href="/v3/">Webhooks</a></h2>
+
     <ul>
 
     </ul>
   </div>
-  
+
   <div id="wrapper">
     <div class="content">
       <%= yield %>
@@ -19,19 +19,19 @@ <h2><a href="/v3/">Hooks</a></h2>
     <div id="js-sidebar" class="sidebar-shell">
       <div class="sidebar-module">
         <ul>
-          <li><h3><a href="/hooks/creating">Creating Hooks</a></h3></li>
-          <li><h3><a href="/hooks/configuring/">Configuring Your Server</a></h3></li>
-          <li><h3><a href="/hooks/testing/">Testing Hooks</a></h3></li>
+          <li><h3><a href="/webhooks/creating">Creating Webhooks</a></h3></li>
+          <li><h3><a href="/webhooks/configuring/">Configuring Your Server</a></h3></li>
+          <li><h3><a href="/webhooks/testing/">Testing Webhooks</a></h3></li>
         </ul>
       </div>
-      
+
       <div class="sidebar-module notice">
         <p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>
       </div>
       <div class="sidebar-module api-status"><a href="https://status.github.com" class="unknown">API Status</a></div>
     </div><!-- sidebar-shell -->
   </div><!-- #wrapper -->
-    
+
   <%= render 'footer' %>
 </body>
 </html>
