Merge pull request #1437 from coralproject/docs-updates

Docs updates

docs/_config.yml

@@ -73,14 +73,12 @@ deploy:
 
 sidebar:
   top:
-    - title: Github
+    - title: GitHub
       url: https://github.com/coralproject/
     - title: Docker
       url: https://hub.docker.com/r/coralproject/
     - title: Roadmap
       url: https://www.pivotaltracker.com/n/projects/1863625
-    - title: Google Group
-      url: https://groups.google.com/forum/#!forum/coral-talk-users
   side:
     - title: Installation
       children:
@@ -142,10 +140,8 @@ sidebar:
           url: /reference/server/
         - title: GraphQL
           url: /reference/graphql/
-    - title: FAQ
-      children:
-        - title: FAQ
-          url: /faq/
+    - title: Contact
+      url: /contact/
     - title: Migrating
       children:
         - title: Migrating to v4.0.0

docs/source/01-03-installation-from-source.md

@@ -6,7 +6,7 @@ permalink: /installation-from-source/
 To install Talk from Source, ensure that you have Node version 8+.
 Installing via source is the recommended method when developing as it give you
 the best tooling. We release versions using semantic versioning, and do so to
-our [Github Releases](https://github.com/coralproject/talk/releases) page.
+our [GitHub Releases](https://github.com/coralproject/talk/releases) page.
 There you can download archives of older versions or the latest release. The
 examples following will download the latest code on our master branch.
 

docs/source/contact.md

@@ -1,6 +1,6 @@
 ---
-title: FAQ
-permalink: /faq/
+title: Contact
+permalink: /contact/
 ---
 
 ## How can I get help integrating Talk into my newsroom?
@@ -10,8 +10,8 @@ We're here to help with newsrooms of all sizes. Email our Integration Engineer
 
 ## How do I request a feature or submit a bug?
 
-The best way is to [submit a Github issue](https://github.com/coralproject/talk/issues). Make sure you give plenty of details, our Core Team can usually respond within a few hours on weekdays.
+The best way is to [submit a GitHub issue](https://github.com/coralproject/talk/issues). Make sure you give plenty of details, our Core Team can usually respond within a few hours on weekdays.
 
 ## How can our dev team contribute to Talk?
 
-We are lucky to work with newsroom dev teams and individual contributors who span the world, and come from newsrooms of all sizes. You can read our [Contribution Guide](https://github.com/coralproject/talk/blob/master/CONTRIBUTING.md) to get started, but feel free to reach out to us via Github, or get in touch directly with Jeff via jeff@mozillafoundation.org.
+We are lucky to work with newsroom dev teams and individual contributors who span the world, and come from newsrooms of all sizes. You can read our [Contribution Guide](https://github.com/coralproject/talk/blob/master/CONTRIBUTING.md) to get started, but feel free to reach out to us via GitHub, or get in touch directly with Jeff via jeff@mozillafoundation.org.

docs/source/integrating/translations-i18n.md

@@ -23,6 +23,6 @@ That would set the language to French.
 
 To add a new Talk translation, simply translate the `en.yml` file (https://github.com/coralproject/talk/blob/master/locales/en.yml) into a new yml file with the language code of your choice. You can find supported language codes here: http://www.localeplanet.com/icu/iso639.html
 
-If you are a developer contributing a new language, you'll need to add the required i18n support in the i18n files (or you can leave that to us if you like). If you're a non-developer, you can submit the translation via Github if you feel comfortable doing that, or feel free to email it to us via our Support: support@coralproject.net
+If you are a developer contributing a new language, you'll need to add the required i18n support in the i18n files (or you can leave that to us if you like). If you're a non-developer, you can submit the translation via GitHub if you feel comfortable doing that, or feel free to email it to us via our Support: support@coralproject.net
 
-If you want to suggest a new language or put a placeholder for a translation you’re working on, feel free to create a Github issue: https://github.com/coralproject/talk/issues/new
+If you want to suggest a new language or put a placeholder for a translation you’re working on, feel free to create a GitHub issue: https://github.com/coralproject/talk/issues/new

docs/themes/coral/layout/partial/sidebar.swig

@@ -7,16 +7,22 @@
   </a>
   <ul class="sidebar__list">
   {% for item in config.sidebar.side %}
-    <li class="sidebar__section{% for item in item.children %}{% if is_current(item.url) %} active toggled{% endif %}{% endfor %}">
-      <a href="#" class="sidebar__header">{{ item.title }}</a>
-      <ul class="sidebar__links">
-        {% for item in item.children %}
-          <li class="{% if is_current(item.url) %}active{% endif %}">
-            <a href="{% if !is_current(item.url) %}{{ url_for(item.url) }}{% else %}#{% endif %}">{{ item.title }}</a>
-          </li>
-        {% endfor %}
-      </ul>
-    </li>
+      {% if item.url %}
+        <li class="sidebar__section{% if is_current(item.url) %} active toggled{% endif %}">
+            <a href="{{ url_for(item.url) }}" class="sidebar__header sidebar__header__link">{{ item.title }}</a>
+        </li>
+      {% else %}
+        <li class="sidebar__section{% for item in item.children %}{% if is_current(item.url) %} active toggled{% endif %}{% endfor %}">
+            <a href="#" class="sidebar__header">{{ item.title }}</a>
+            <ul class="sidebar__links">
+              {% for item in item.children %}
+                <li class="{% if is_current(item.url) %}active{% endif %}">
+                  <a href="{% if !is_current(item.url) %}{{ url_for(item.url) }}{% else %}#{% endif %}">{{ item.title }}</a>
+                </li>
+              {% endfor %}
+            </ul>
+        </li>
+      {% endif %}
     {% endfor %}
   </ul>
 

docs/themes/coral/source/js/main.js

@@ -28,7 +28,7 @@ $(document).ready(function() {
   });
 
   // Setup the menu controls.
-  $('a.sidebar__header').on('click', function(e) {
+  $('a.sidebar__header:not(.sidebar__header__link)').on('click', function(e) {
     e.preventDefault();
     $('.sidebar__section.toggled').removeClass('toggled');
     $(this)

test/server/services/tokens.js

@@ -19,7 +19,7 @@ describe('services.TokensService', () => {
 
   describe('#create', () => {
     it('can create the token without error', async () => {
-      let token = await TokensService.create(user.id, 'Github Token');
+      let token = await TokensService.create(user.id, 'GitHub Token');
       expect(token).to.be.an.object;
       expect(token.jwt).to.be.a.string;
       expect(token.pat).to.be.an.object;
@@ -35,7 +35,7 @@ describe('services.TokensService', () => {
 
   describe('#revoke', () => {
     it('can revoke a token', async () => {
-      let { pat: { id } } = await TokensService.create(user.id, 'Github Token');
+      let { pat: { id } } = await TokensService.create(user.id, 'GitHub Token');
 
       let tokens = await TokensService.list(user.id);
       expect(tokens).to.have.length(1);
@@ -54,7 +54,7 @@ describe('services.TokensService', () => {
   describe('#validate', () => {
     it('will allow a valid token', async () => {
       // Create a token.
-      let { pat: { id } } = await TokensService.create(user.id, 'Github Token');
+      let { pat: { id } } = await TokensService.create(user.id, 'GitHub Token');
 
       // Validate it.
       await TokensService.validate(user.id, id);
@@ -62,7 +62,7 @@ describe('services.TokensService', () => {
 
     it('will not allow an invalid token', async () => {
       // Create a token.
-      let { pat: { id } } = await TokensService.create(user.id, 'Github Token');
+      let { pat: { id } } = await TokensService.create(user.id, 'GitHub Token');
 
       // Revoke it.
       await TokensService.revoke(user.id, id);
@@ -78,7 +78,7 @@ describe('services.TokensService', () => {
       expect(tokens).to.have.length(0);
 
       // Create a token.
-      let { pat: { id } } = await TokensService.create(user.id, 'Github Token');
+      let { pat: { id } } = await TokensService.create(user.id, 'GitHub Token');
 
       tokens = await TokensService.list(user.id);
       expect(tokens).to.have.length(1);