Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit e904014

Browse files
committed
Merge remote-tracking branch 'origin/master' into clarify-beta-v3-differences
2 parents 07fab06 + 1ac1130 commit e904014

26 files changed

Lines changed: 802 additions & 199 deletions

Rakefile

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ task :compile do
55
`nanoc compile`
66
end
77

8-
# prompt user for a commit message; default: HEAD commit 1-liner
8+
# Prompt user for a commit message; default: P U B L I S H :emoji:
99
def commit_message
10-
last_commit = `git log -1 --pretty=format:"%s"`.chomp.strip
11-
last_commit = 'Publishing developer content to GitHub pages.' if last_commit == ''
10+
publish_emojis = [':boom:', ':rocket:', ':metal:', ':bulb:', ':zap:',
11+
':sailboat:', ':gift:', ':ship:', ':shipit:', ':sparkles:', ':rainbow:']
12+
default_message = "P U B L I S H #{publish_emojis.sample}"
1213

13-
print "Enter a commit message (default: '#{last_commit}'): "
14+
print "Enter a commit message (default: '#{default_message}'): "
1415
STDOUT.flush
1516
mesg = STDIN.gets.chomp.strip
1617

17-
mesg = last_commit if mesg == ''
18-
mesg.gsub(/'/, '') # to allow this to be handed off via -m '#{message}'
18+
mesg = default_message if mesg == ''
19+
mesg.gsub(/'/, '') # Allow this to be handed off via -m '#{message}'
1920
end
2021

2122
desc "Publish to http://developer.github.com"

Rules

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
# item, use the pattern “/about/*/”; “/about/*” will also select the parent,
1111
# because “*” matches zero or more characters.
1212

13+
# Reset search-index by deleting it every time
14+
preprocess do
15+
File.delete("output/search-index.json") if File.exists?("output/search-index.json")
16+
end
17+
1318
compile '/static/*' do
1419
end
1520

@@ -22,6 +27,7 @@ compile '/feed/' do
2227
end
2328

2429
compile '/v3/*' do
30+
filter :search
2531
filter :erb
2632
filter :kramdown, :toc_levels => [2]
2733
filter :colorize_syntax,

content/index.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,21 @@ GitHub in your app</h1>
1313

1414
<div class="full-width-divider">
1515
<ul class="wrapper highlights">
16-
<li>
17-
<h2>Get Started</h2>
16+
<li class="highlight-module">
17+
<a href="/guides/"><span class="mega-icon octicon-file-text"></span></a>
18+
<h2><a href="/guides/">Get Started</a></h2>
1819
<p>New to the GitHub API? With these guides you’ll be up and running in a snap.</p>
19-
<a href="/guides/" class="button-secondary">View introduction guides</a>
20-
<img class="octocat professorcat" src="/shared/images/professorcat.png">
2120
</li>
22-
<li>
23-
<h2>Libraries</h2>
21+
<li class="highlight-module">
22+
<a href="/libraries/"><span class="mega-icon octicon-code"></span></a>
23+
<h2><a href="/libraries/">Libraries</a></h2>
2424
<p>We’ve got you covered. Use the GitHub API in your favorite language.</p>
25-
<a href="/libraries/" class="button-secondary">Browse libraries</a>
26-
<img class="octocat" src="/shared/images/gundamcat-small.png">
2725
</li>
28-
<li>
29-
<h2>Support</h2>
26+
<li class="highlight-module">
27+
<a href="http://github.com/contact"><span class="mega-icon octicon-mail-read"></span></a>
28+
<h2><a href="http://github.com/contact">Support</a></h2>
3029
<p>Are you stuck? Already tried our <a href="/v3/troubleshooting/">troubleshooting guide</a>? Talk to a supportocat.</p>
31-
<a href="http://github.com/contact" class="button-secondary">Get in touch</a>
32-
<img class="octocat" src="/shared/images/supportocat.png">
3330
</li>
3431
3532
</ul>
3633
</div>
37-

content/v3/activity/notifications.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,32 @@ of high server load, the time may increase. Please obey the header.
4949
HTTP/1.1 304 Not Modified
5050
X-Poll-Interval: 60
5151

52+
## Notification Reasons
53+
54+
When retrieving responses from the Notifications API, each payload has a key titled
55+
`reason`. These correspond to events that trigger a notification.
56+
57+
Here's a list of potential `reason`s for receiving a notification:
58+
59+
Reason Name | Description
60+
------------|------------
61+
`subscribed` | The notification arrived because you're watching the repository
62+
`manual` | The notification arrived because you've specifically decided to watch the item (via an Issue or Pull Request)
63+
`author` | The notification arrived because you've created the item
64+
`comment` | The notification arrived because you've commented on the item
65+
`mention` | The notification arrived because you were specifically **@mentioned** in the content
66+
`team_mention` | The notification arrived because you were on a team that was mentioned (like @org/team)
67+
`state_change` | The notification arrived because you changed the item state (like closing an Issue or merging a Pull Request)
68+
`assign` | The notification arrived because you were assigned to the Issue
69+
70+
Note that the `reason` is modified on a per-thread basis, and can change, if the
71+
`reason` on a later notification is different.
72+
73+
For example, if you are the author of an issue, subsequent notifications on that
74+
issue will have a `reason` of `author`. If you're then **@mentioned** on the same
75+
issue, the notifications you fetch thereafter will have a `reason` of `mention`.
76+
The `reason` remains as `mention`, regardless of whether you're ever mentioned again.
77+
5278
## List your notifications
5379

5480
List all notifications for the current user, grouped by repository.

content/v3/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Authentication | GitHub API
2+
title: Other Authentication Methods | GitHub API
33
---
44

55
# Other Authentication Methods

content/v3/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Git | GitHub API
2+
title: Git Data | GitHub API
33
---
44

55
# Git Data

content/v3/pulls/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Pull Request Comments | GitHub API
2+
title: Review Comments | GitHub API
33
---
44

55
# Review Comments

content/v3/repos/downloads.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ title: Downloads | GitHub API
77
* TOC
88
{:toc}
99

10+
### Downloads API is Deprecated
11+
12+
<div class="alert">
13+
<p>
14+
The Downloads API (described below) was
15+
<a href="https://github.com/blog/1302-goodbye-uploads">deprecated on December 11, 2012</a>.
16+
It will be removed at a future date.
17+
18+
We recommend using <a href="/v3/repos/releases/">Releases</a> instead.
19+
</p>
20+
</div>
21+
1022
The downloads API is for package downloads only. If you want to get
1123
source tarballs you should use [this](/v3/repos/contents/#get-archive-link)
1224
instead.

content/v3/search/legacy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ v3. There should be no changes, other than the new URL and JSON output format.
1515
<div class="alert">
1616
<p>
1717
The Legacy Search API (described below) is <a href="/v3/versions/#v3-deprecations">deprecated</a>
18-
and is scheduled for removal in the next version of the API.
18+
and is scheduled for removal in the next major version of the API.
1919

2020
We recommend using the <a href="/v3/search/">v3 Search API</a> instead.
2121
It contains new endpoints and much more functionality.
@@ -30,7 +30,7 @@ Find issues by state and keyword.
3030

3131
### Parameters
3232

33-
Name | Type | Description
33+
Name | Type | Description
3434
-----|------|--------------
3535
`state`|`string` | Indicates the state of the issues to return. Can be either `open` or `closed`.
3636
`keyword`|`string`| The search term.
@@ -49,7 +49,7 @@ pages can be fetched using the `start_page` parameter.
4949

5050
### Parameters
5151

52-
Name | Type | Description
52+
Name | Type | Description
5353
-----|------|--------------
5454
`keyword`|`string`| The search term|
5555
`language`|`string` | Filter results by [language](https://github.com/languages)
@@ -69,7 +69,7 @@ Find users by keyword.
6969

7070
### Parameters
7171

72-
Name | Type | Description
72+
Name | Type | Description
7373
-----|------|--------------
7474
`keyword`|`string`| The search term
7575
`start_page`|`string` | The page number to fetch
@@ -91,7 +91,7 @@ address must be left unencoded. Searches only against public email addresses
9191

9292
### Parameters
9393

94-
Name | Type | Description
94+
Name | Type | Description
9595
-----|------|--------------
9696
`email`|`string`| The email address
9797

layouts/header.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
<li><a href="/v3/" class="nav-api">API</a></li>
88
<li><a href="/changes/" class="nav-blog">Blog</a></li>
99
<li><a href="https://github.com/contact">Support</a></li>
10+
<li id="search-container">
11+
<input type="text" id="searchfield" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" /><label class="search-placeholder">Search</label>
12+
<div class="cancel-search"></div>
13+
<ul id="search-results">
14+
15+
</ul>
16+
</li>
1017
</ul>
1118
</div>
1219
</div><!-- #header -->

0 commit comments

Comments
 (0)