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

Commit 031ee23

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent 4a207ac commit 031ee23

File tree

6 files changed

+588
-60
lines changed

6 files changed

+588
-60
lines changed

LICENSE.txt

Lines changed: 524 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 58 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,43 @@ This is a GitHub API resource built with [Nanoc][nanoc].
44

55
All submissions are welcome. To submit a change, fork this repo, commit your changes, and send us a [pull request](http://help.github.com/send-pull-requests/).
66

7-
## Setup
8-
9-
Ruby 2.2 is required to build the site.
7+
## Development
108

11-
Get the Nanoc gem, plus kramdown for Markdown parsing:
9+
You can fetch the latest dependencies by opening the command line and running `script/bootstrap`:
1210

13-
```sh
14-
$ bundle install
11+
``` sh
12+
$ script/bootstrap
13+
==> Installing gem dependencies…
14+
==> Installing npm dependencies…
1515
```
1616

17-
You can see the available commands with Nanoc:
17+
You'll need Ruby and Node installed on your system. The required versions for each of these languages can be found in the *.ruby-version* and *package.json* files, respectively.
1818

19-
```sh
20-
$ bundle exec nanoc -h
19+
You can run `bundle exec rake build` to generate the site, but it's often more useful
20+
to simply build the server *and* start the site at the same time.
21+
22+
Nanoc compiles the site into static files living in `output`. It's
23+
smart enough not to try to compile unchanged files.
24+
25+
You can start the site with `script/server`:
26+
27+
``` sh
28+
$ script/server
29+
Loading site data...
30+
Compiling site...
31+
create [0.28s] output/index.html
32+
create [1.31s] output/v3/gists/comments/index.html
33+
identical [1.92s] output/v3/gists/index.html
34+
identical [0.25s] output/v3/issues/comments/index.html
35+
update [0.99s] output/v3/issues/labels/index.html
36+
update [0.05s] output/v3/index.html
37+
38+
39+
Site compiled in 5.81s.
2140
```
2241

42+
The site is hosted at `http://localhost:4000`.
43+
2344
Nanoc has [some nice documentation](http://nanoc.ws/docs/tutorial/) to get you started. Though if you're mainly concerned with editing or adding content, you won't need to know much about Nanoc.
2445

2546
[nanoc]: http://nanoc.ws/
@@ -93,52 +114,36 @@ of commands.
93114

94115
For more information, see [the reference documentation](https://github.com/gjtorikian/extended-markdown-filter#command-line-highlighting).
95116

96-
## Development
97-
98-
You can fetch the latest dependencies by opening the command line and running `script/bootstrap`:
99-
100-
``` sh
101-
$ script/bootstrap
102-
==> Installing gem dependencies…
103-
==> Installing npm dependencies…
104-
```
105-
106-
You'll need Ruby 2.2.3 and at least Node v4.x.
107-
108-
You can run `bundle exec rake build` to generate the site, but it's often more useful
109-
to simply build the server *and* start the site at the same time.
110-
111-
Nanoc compiles the site into static files living in `./output`. It's
112-
smart enough not to try to compile unchanged files.
113-
114-
You can start the site with `script/server`:
115-
116-
``` sh
117-
$ script/server
118-
Loading site data...
119-
Compiling site...
120-
identical [0.00s] output/css/960.css
121-
identical [0.00s] output/css/pygments.css
122-
identical [0.00s] output/css/reset.css
123-
identical [0.00s] output/css/styles.css
124-
identical [0.00s] output/css/uv_active4d.css
125-
update [0.28s] output/index.html
126-
update [1.31s] output/v3/gists/comments/index.html
127-
update [1.92s] output/v3/gists/index.html
128-
update [0.25s] output/v3/issues/comments/index.html
129-
update [0.99s] output/v3/issues/labels/index.html
130-
update [0.49s] output/v3/issues/milestones/index.html
131-
update [0.50s] output/v3/issues/index.html
132-
update [0.05s] output/v3/index.html
133-
134-
135-
Site compiled in 5.81s.
136-
```
137-
138-
The site is hosted at `http://localhost:4000`.
139-
140117
## Deploy
141118

142119
```sh
143120
$ bundle exec rake publish
144121
```
122+
123+
## Licenses
124+
125+
The code to generate the site (everything excluding the assets, content,
126+
and layouts directories) as well as the code samples on the site are
127+
licensed under
128+
[CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
129+
CC0 waives all copyright restrictions but does not grant you any trademark
130+
permissions.
131+
132+
Site content (everything in the assets, content, and layouts directories,
133+
excluding files under open source licenses individually marked) is licensed
134+
under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0
135+
gives you permission to use content for almost any purpose but does not grant
136+
you any trademark permissions, so long as you note the license and give credit,
137+
such as follows:
138+
139+
> Content based on
140+
> <a href="https://github.com/github/developer.github.com">developer.github.com</a>
141+
> used under the
142+
> <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>
143+
> license.</a>
144+
145+
This means you can use the code and content in this repository except for
146+
GitHub trademarks in your own projects.
147+
148+
When you contribute to this repository you are doing so under the above
149+
licenses.

assets/stylesheets/documentation.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,7 @@ a .mega-octicon {
843843

844844
.footer-cell li {
845845
display: inline;
846-
margin-right: 20px;
846+
margin-right: 9px;
847847
list-style: none;
848848
}
849849

content/changes/2013-08-20-search-api-improvements.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For example, when [searching for files that have "client" in their path][example
3838
## Better Text Match Metadata
3939

4040
Before today, the API applied HTML entity encoding to all `fragment` data.
41-
For example, imagine your search returns an issue like [rails/rails#11889][example-issue]:
41+
For example, imagine your search returns an issue like <a href="https://github.com/rails/rails/issues/11889" data-proofer-ignore>rails/rails#11889</a>:
4242

4343
![Example Issue Title](https://f.cloud.github.com/assets/2988/994632/a84f2888-09af-11e3-9417-4bd92f1f1ed6.png)
4444

@@ -67,7 +67,6 @@ We appreciate everyone that has provided feedback so far. Please [keep it coming
6767

6868
[contact]: https://github.com/contact?form[subject]=New+Search+API
6969
[code-text-matches]: /v3/search/#highlighting-code-search-results
70-
[example-issue]: https://github.com/rails/rails/issues/11889
7170
[example-path-search]: https://github.com/search?q=%40octokit%2Foctokit.rb+in%3Apath+client&type=Code
7271
[original-search-api-announcement]: /changes/2013-07-19-preview-the-new-search-api/
7372
[preview-period]: /changes/2013-07-19-preview-the-new-search-api/#preview-period

layouts/footer.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<div id="footer" >
22
<div class="lower_footer">
33
<ul class="footer-cell">
4+
<li><a href="https://github.com/github/developer.github.com#licenses">&copy; <%= Time.now.year %> GitHub, Inc.</a></li>
45
<li><a href="https://help.github.com/terms-of-service/">Terms</a></li>
56
<li><a href="https://help.github.com/privacy-policy/">Privacy</a></li>
67
<li><a href="https://help.github.com/security/">Security</a></li>
@@ -20,10 +21,6 @@
2021
</ul>
2122
</div>
2223

23-
<div class="wrapper">
24-
<p>Design &copy; <%= Time.now.year %> Copyright <%= Time.now.year %> GitHub, Inc. </p>
25-
</div>
26-
2724
</div><!-- /#footer -->
2825
<script>
2926
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,8 @@
2121
"repository": {
2222
"type" : "git",
2323
"url" : "https://github.com/github/help-docs.git"
24+
},
25+
"engines": {
26+
"node": ">= 4.0.0"
2427
}
2528
}

0 commit comments

Comments
 (0)