Sfoglia il codice sorgente

Copy changes to reflect that DevDocs is now operated by freeCodeCamp

Thibaut Courouble 7 anni fa
parent
commit
b6358992d5

+ 1 - 1
.github/CONTRIBUTING.md

@@ -35,7 +35,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
 ## Contributing code and features
 
 1. Search for existing issues; someone may already be working on a similar feature.
-2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature.
+2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature.
 3. Follow the [coding conventions](#coding-conventions).
 4. If you're modifying the Ruby code, include tests and ensure they pass.
 5. Try to keep your pull request small and simple.

+ 3 - 3
COPYRIGHT

@@ -5,9 +5,9 @@ Copyright 2013-2018 Thibaut Courouble and other contributors
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 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.
+derived from this software without the maintainers' permission, except
+as may be necessary to comply with the notice/attribution requirements.
 
-I also wish that any documentation file generated using this software
+We also wish that any documentation file generated using this software
 be attributed to DevDocs. Let's be fair to all contributors by giving
 credit where credit's due. Thanks.

+ 6 - 6
README.md

@@ -1,8 +1,8 @@
-# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
+# [DevDocs](https://devdocs.io) — API Documentation Browser [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
 
-DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
+DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
 
-* Created by [Thibaut Courouble](https://thibaut.me)
+DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org).
 
 Keep track of development news:
 
@@ -14,7 +14,7 @@ Keep track of development news:
 
 ## Quick Start
 
-Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
+Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
 
 DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
 
@@ -138,9 +138,9 @@ Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.co
 
 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.
 
-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.
+Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements.
 
-I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
+We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
 
 ## Questions?
 

+ 3 - 3
assets/javascripts/templates/error_tmpl.coffee

@@ -62,12 +62,12 @@ app.templates.unsupportedBrowser = """
       <li>iOS 10+
     </ul>
     <p class="_fail-text">
-      If you're unable to upgrade, I apologize.
-      I decided to prioritize speed and new features over support for older browsers.
+      If you're unable to upgrade, we apologize.
+      We decided to prioritize speed and new features over support for older browsers.
     <p class="_fail-text">
       Note: if you're already using one of the browsers above, check your settings and add-ons.
       The app uses feature detection, not user agent sniffing.
     <p class="_fail-text">
-      &mdash; Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>
+      &mdash; <a href="https://twitter.com/DevDocs">@DevDocs</a>
   </div>
 """

+ 6 - 11
assets/javascripts/templates/pages/about_tmpl.coffee

@@ -11,16 +11,12 @@ app.templates.aboutPage = -> """
   </nav>
 
   <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1>
-  <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.
-  <ul>
-    <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a>
-    <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>
-        <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>
-  </ul>
+  <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
+  <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>.
   <p>To keep up-to-date with the latest news:
   <ul>
     <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
-    <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a>
+    <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <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>
     <li>Join the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room
   </ul>
 
@@ -52,7 +48,6 @@ app.templates.aboutPage = -> """
     <dt>Where can I report bugs?
     <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
   </dl>
-  <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
 
   <h2 class="_block-heading" id="credits">Credits</h2>
 
@@ -76,12 +71,12 @@ app.templates.aboutPage = -> """
 
   <h2 class="_block-heading" id="privacy">Privacy Policy</h2>
   <ul>
-    <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by Thibaut Courouble ("We").
-    <li>We do not collect personal information.
+    <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
+    <li>We do not collect personal information through the app.
     <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app.
     <li>The app uses cookies to store user preferences.
     <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app.
-    <li>If you have any questions regarding privacy, please email <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
+    <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.
   </ul>
 """
 

+ 0 - 2
assets/stylesheets/components/_fail.scss

@@ -32,5 +32,3 @@
 }
 
 ._fail-text:last-child { margin: 0; }
-
-._fail-link { float: right; }

+ 3 - 3
views/unsupported.erb

@@ -16,11 +16,11 @@
       <li>iOS 10+</li>
     </ul>
     <p class="_fail-text">
-      If you're unable to upgrade, I apologize.
-      I decided to prioritize speed and new features over support for older browsers.
+      If you're unable to upgrade, we apologize.
+      We decided to prioritize speed and new features over support for older browsers.
     </p>
     <p class="_fail-text">
-      &mdash; Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>
+      &mdash; <a href="https://twitter.com/DevDocs">@DevDocs</a>
     </p>
   </div>
 </body>