History

DevDocs → freeCodeCamp

Thibaut Courouble committed 8 years ago

Commit d48396d1 parent 30a577411 files · +42 −39Browse files

Unified · Split

11 files
  1. CONTRIBUTING.md +2 −2
  2. ISSUE_TEMPLATE.md +1 −1
  3. README.md +10 −10
  4. assets/javascripts/news.json +7 −4
  5. assets/javascripts/templates/notif_tmpl.coffee +1 −1
  6. assets/javascripts/templates/pages/about_tmpl.coffee +9 −9
  7. assets/javascripts/templates/pages/help_tmpl.coffee +1 −1
  8. assets/javascripts/templates/pages/news_tmpl.coffee.erb +1 −1
  9. assets/javascripts/templates/pages/offline_tmpl.coffee +1 −1
  10. assets/javascripts/templates/pages/root_tmpl.coffee.erb +8 −8
  11. assets/javascripts/views/layout/resizer.coffee +1 −1
CONTRIBUTING.md+2−2
@@ -24,7 +24,7 @@ Want to contribute? Great. Please review the following guidelines carefully and · 23 unmodified lines
2424 ## Requesting new features
2525
2626 1. Search for similar feature requests; someone may have already requested it.
27−2. Make sure your feature fits DevDocs's [vision](https://github.com/Thibaut/devdocs/blob/master/README.md#vision).
27+2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
2828 3. Provide a clear and detailed explanation of the feature and why it's important to add it.
2929
3030 For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
@@ -46,7 +46,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 15 unmodified lines
4646
4747 ## Contributing new documentations
4848
49−See the [wiki](https://github.com/Thibaut/devdocs/wiki) to learn how to add new documentations.
49+See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations.
5050
5151 **Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
5252
ISSUE_TEMPLATE.md+1−1
@@ -1,6 +1,6 @@
11 <!--
22 Please read the contributing guidelines before opening an issue:
3− https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md
3+ https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md
44
55 To request a new documentation, or an update of an existing documentation, go here:
66 https://trello.com/b/6BmTulfx/devdocs-documentation
README.md+10−10
@@ -1,4 +1,4 @@
1−# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/Thibaut/devdocs.svg?branch=master)](https://travis-ci.org/Thibaut/devdocs)
1+# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
22
33 DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
44
@@ -7,7 +7,7 @@ DevDocs combines multiple API documentations in a fast, organized, and searchabl · 2 unmodified lines
77 Keep track of development news:
88
99 * Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs)
10−* Watch the repository on [GitHub](https://github.com/Thibaut/devdocs/subscription)
10+* Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription)
1111 * Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
1212 * Join the [mailing list](https://groups.google.com/d/forum/devdocs)
1313
@@ -22,7 +22,7 @@ DevDocs is made of two pieces: a Ruby scraper that generates the documentation a · 8 unmodified lines
2222 DevDocs requires Ruby 2.5.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
2323
2424 ```
25−git clone https://github.com/Thibaut/devdocs.git && cd devdocs
25+git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
2626 gem install bundler
2727 bundle install
2828 bundle exec thor docs:download --default
@@ -33,13 +33,13 @@ Finally, point your browser at [localhost:9292](http://localhost:9292) (the firs · 4 unmodified lines
3333
3434 The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`.
3535
36−**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/Thibaut/devdocs/subscription) this repository.
36+**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/freeCodeCamp/devdocs/subscription) this repository.
3737
3838 Alternatively, DevDocs may be started as a Docker container:
3939
4040 ```
4141 # First, build the image
42−git clone https://github.com/Thibaut/devdocs.git && cd devdocs
42+git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
4343 docker build -t thibaut/devdocs .
4444
4545 # Finally, start a DevDocs container (access http://localhost:9292)
@@ -93,7 +93,7 @@ These modifications are applied via a set of filters using the [HTML::Pipeline]( · 47 unmodified lines
9393
9494 The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).
9595
96−More information about scrapers and filters is available on the [wiki](https://github.com/Thibaut/devdocs/wiki).
96+More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
9797
9898 ## Available Commands
9999
@@ -133,15 +133,15 @@ If multiple versions of Ruby are installed on your system, commands must be run · 33 unmodified lines
133133
134134 ## Contributing
135135
136−Contributions are welcome. Please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md).
136+Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md).
137137
138−DevDocs's own documentation is available on the [wiki](https://github.com/Thibaut/devdocs/wiki).
138+DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
139139
140140 ## Copyright / License
141141
142−Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/Thibaut/devdocs/graphs/contributors)
142+Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
143143
144−This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/Thibaut/devdocs/blob/master/LICENSE) files.
144+This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files.
145145
146146 Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements.
147147
assets/javascripts/news.json+7−4
@@ -1,5 +1,8 @@
11 [
22 [
3+ "2018-03-26",
4+ "DevDocs is joining the freeCodeCamp community. Read the announcement <a href=\"https://medium.com/@quincylarson/devdocs-is-joining-the-freecodecamp-community-ae185a1c14a6\" target=\"_blank\">here</a>."
5+ ], [
36 "2018-02-04",
47 "New documentations: <a href=\"/babel/\">Babel</a>, <a href=\"/jekyll/\">Jekyll</a> and <a href=\"/jsdoc/\">JSDoc</a>"
58 ], [
@@ -7,7 +10,7 @@ · 1 unmodified line
710 "New documentations: <a href=\"/bluebird/\">Bluebird</a>, <a href=\"/eslint/\">ESLint</a> and <a href=\"/homebrew/\">Homebrew</a>"
811 ], [
912 "2017-11-18",
10− "Added print & PDF stylesheet.\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/Thibaut/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
13+ "Added print & PDF stylesheet.\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/freeCodeCamp/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
1114 ], [
1215 "2017-09-10",
1316 "<a href=\"/settings\">Preferences</a> can now be exported and imported."
@@ -119,7 +122,7 @@ · 105 unmodified lines
119122 "New documentations: <a href=\"/q/\">Q</a> and <a href=\"/opentsdb/\">OpenTSDB</a>"
120123 ], [
121124 "2015-07-26",
122− "Added search aliases (e.g. <code class=\"_label\">$</code> is an alias for <code class=\"_label\">jQuery</code>).\n<a href=\"/help#aliases\">Click here</a> to see the full list. Feel free to suggest more on <a href=\"https://github.com/Thibaut/devdocs/issues/new\" target=\"_blank\" rel=\"noopener\">GitHub</a>.",
125+ "Added search aliases (e.g. <code class=\"_label\">$</code> is an alias for <code class=\"_label\">jQuery</code>).\n<a href=\"/help#aliases\">Click here</a> to see the full list. Feel free to suggest more on <a href=\"https://github.com/freeCodeCamp/devdocs/issues/new\" target=\"_blank\" rel=\"noopener\">GitHub</a>.",
123126 "Added <code class=\"_label\">shift + &darr;/&uarr;</code> shortcut for scrolling (same as <code class=\"_label\">alt + &darr;/&uarr;</code>)."
124127 ], [
125128 "2015-07-05",
@@ -160,7 +163,7 @@ · 34 unmodified lines
160163 "New <a href=\"/python2/\">Python 2</a> documentation"
161164 ], [
162165 "2014-11-09",
163− "New design\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/Thibaut/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
166+ "New design\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/freeCodeCamp/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
164167 ], [
165168 "2014-10-19",
166169 "New <a href=\"/svg/\">SVG</a>, <a href=\"/marionette/\">Marionette.js</a>, and <a href=\"/mongoose/\">Mongoose</a> documentations"
@@ -245,7 +248,7 @@ · 78 unmodified lines
245248 "New <a href=\"/ruby/\">Ruby</a> documentation"
246249 ], [
247250 "2013-10-24",
248− "DevDocs is now <a href=\"https://github.com/Thibaut/devdocs\">open source</a>."
251+ "DevDocs is now <a href=\"https://github.com/freeCodeCamp/devdocs\">open source</a>."
249252 ], [
250253 "2013-10-09",
251254 "DevDocs is now available as a <a href=\"https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe\">Chrome web app</a>."
assets/javascripts/templates/notif_tmpl.coffee+1−1
@@ -16,7 +16,7 @@ app.templates.notifError = -> · 15 unmodified lines
1616 textNotif """ Oops, an error occurred. """,
1717 """ Try <a href="#" data-behavior="hard-reload">reloading</a>, and if the problem persists,
1818 <a href="#" data-behavior="reset">resetting the app</a>.<br>
19− You can also report this issue on <a href="https://github.com/Thibaut/devdocs/issues/new" target="_blank" rel="noopener">GitHub</a>. """
19+ You can also report this issue on <a href="https://github.com/freeCodeCamp/devdocs/issues/new" target="_blank" rel="noopener">GitHub</a>. """
2020
2121 app.templates.notifQuotaExceeded = ->
2222 textNotif """ The offline database has exceeded its size limitation. """,
assets/javascripts/templates/pages/about_tmpl.coffee+9−9
@@ -14,23 +14,23 @@ app.templates.aboutPage = -> """ · 13 unmodified lines
1414 <p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
1515 <ul>
1616 <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a>
17− <li>Free and <a href="https://github.com/Thibaut/devdocs">open source</a>
18− <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=Thibaut&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
17+ <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>
18+ <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
1919 </ul>
2020 <p>To keep up-to-date with the latest news:
2121 <ul>
2222 <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
23− <li>Watch the repository on <a href="https://github.com/Thibaut/devdocs/subscription">GitHub</a>
23+ <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a>
2424 <li>Join the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>
2525 </ul>
2626
2727 <h2 class="_block-heading" id="copyright">Copyright and License</h2>
2828 <p class="_note">
29− <strong>Copyright 2013&ndash;2018 Thibaut Courouble and <a href="https://github.com/Thibaut/devdocs/graphs/contributors">other contributors</a></strong><br>
29+ <strong>Copyright 2013&ndash;2018 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
3030 This software is licensed under the terms of the Mozilla Public License v2.0.<br>
31− You may obtain a copy of the source code at <a href="https://github.com/Thibaut/devdocs">github.com/Thibaut/devdocs</a>.<br>
32− For more information, see the <a href="https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
33− and <a href="https://github.com/Thibaut/devdocs/blob/master/LICENSE">LICENSE</a> files.
31+ You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
32+ For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
33+ and <a href="https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE">LICENSE</a> files.
3434
3535 <h2 class="_block-heading" id="plugins">Plugins and Extensions</h2>
3636 <ul>
@@ -47,10 +47,10 @@ app.templates.aboutPage = -> """ · 10 unmodified lines
4747 <dl>
4848 <dt>Where can I suggest new docs and features?
4949 <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
50− If you have a specific feature request, add it to the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>.<br>
50+ If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
5151 Otherwise use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
5252 <dt>Where can I report bugs?
53− <dd>In the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>. Thanks!
53+ <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
5454 </dl>
5555 <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
5656
assets/javascripts/templates/pages/help_tmpl.coffee+1−1
@@ -151,5 +151,5 @@ app.templates.helpPage = -> · 150 unmodified lines
151151 #{("<tr><td class=\"_code\">#{key}<td class=\"_code\">#{value}" for key, value of aliases_two).join('')}
152152 </table>
153153 </div>
154− <p>Feel free to suggest new aliases on <a href="https://github.com/Thibaut/devdocs/issues/new">GitHub</a>.
154+ <p>Feel free to suggest new aliases on <a href="https://github.com/freeCodeCamp/devdocs/issues/new">GitHub</a>.
155155 """
assets/javascripts/templates/pages/news_tmpl.coffee.erb+1−1
@@ -4,7 +4,7 @@ app.templates.newsPage = -> · 3 unmodified lines
44 """ <h1 class="_lined-heading">Changelog</h1>
55 <p class="_note">
66 For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.<br>
7− For development updates, follow the project on <a href="https://github.com/Thibaut/devdocs">GitHub</a>.
7+ For development updates, follow the project on <a href="https://github.com/freeCodeCamp/devdocs">GitHub</a>.
88 <div class="_news">#{app.templates.newsList app.news}</div> """
99
1010 app.templates.newsList = (news, options = {}) ->
assets/javascripts/templates/pages/offline_tmpl.coffee+1−1
@@ -32,7 +32,7 @@ app.templates.offlinePage = (docs) -> """ · 31 unmodified lines
3232 <dt>What if I don't update a documentation?
3333 <dd>You'll see outdated content and some pages will be missing or broken, because the rest of the app (including data for the search and sidebar) uses a different caching mechanism that's updated automatically.
3434 <dt>I found a bug, where do I report it?
35− <dd>In the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>. Thanks!
35+ <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
3636 <dt>How do I uninstall/reset the app?
3737 <dd>Click <a href="#" data-behavior="reset">here</a>.
3838 <dt>Why aren't all documentations listed above?
assets/javascripts/templates/pages/root_tmpl.coffee.erb+8−8
@@ -12,13 +12,13 @@ app.templates.intro = """ · 11 unmodified lines
1212 <li>Run <code>thor docs:list</code> to see all available documentations.
1313 <li>Run <code>thor docs:download &lt;name&gt;</code> to download documentations.
1414 <li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
15− <li>To be notified about new versions, don't forget to <a href="https://github.com/Thibaut/devdocs/subscription">watch the repository</a> on GitHub.
16− <li>The <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
15+ <li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub.
16+ <li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
1717 feature requests. For everything else, use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
18− <li>Contributions are welcome. See the <a href="https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
18+ <li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
1919 <li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
20− see the <a href="https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and
21− <a href="https://github.com/Thibaut/devdocs/blob/master/LICENSE">LICENSE</a> files.
20+ see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and
21+ <a href="https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE">LICENSE</a> files.
2222 </ol>
2323 <p>Happy coding!
2424 </div></div>
@@ -38,8 +38,8 @@ app.templates.intro = """ · 13 unmodified lines
3838 <li>You can search using your browser's address bar &mdash; <a href="/help#browser_search">learn how</a>.
3939 <li>DevDocs works <a href="/offline">offline</a>, on mobile, and can be installed on <a href="https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe">Chrome</a>.
4040 <li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
41− <li>DevDocs is free and <a href="https://github.com/Thibaut/devdocs">open source</a>.
42− <iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=Thibaut&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
41+ <li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
42+ <iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
4343 <li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>.
4444 </ol>
4545 <p>Happy coding!
@@ -57,7 +57,7 @@ app.templates.mobileIntro = """ · 11 unmodified lines
5757 <li>The search supports fuzzy matching.
5858 <li>To search a specific documentation, type its name (or an abbr.), then Space.
5959 <li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
60− <li>DevDocs is <a href="https://github.com/Thibaut/devdocs">open source</a>.
60+ <li>DevDocs is <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
6161 </ol>
6262 <p>Happy coding!
6363 <a class="_intro-hide" data-hide-intro>Stop showing this message</a>
assets/javascripts/views/layout/resizer.coffee+1−1
@@ -50,7 +50,7 @@ class app.views.Resizer extends app.View · 49 unmodified lines
5050 onDragEnd: (event) =>
5151 $.off(window, 'dragover', @onDrag)
5252 value = event.pageX or (event.screenX - window.screenX)
53− if @lastDragValue and not (@lastDragValue - 5 < value < @lastDragValue + 5) # https://github.com/Thibaut/devdocs/issues/265
53+ if @lastDragValue and not (@lastDragValue - 5 < value < @lastDragValue + 5) # https://github.com/freeCodeCamp/devdocs/issues/265
5454 value = @lastDragValue
5555 @resize(value, true)
5656 return