fixed broken links, added username restrictions, minor docs updates (#2580)

This commit is contained in:
immber
2019-09-20 19:31:20 +00:00
committed by Wyatt Johnson
parent 9db7571fe2
commit 0af28edbd9
6 changed files with 10 additions and 6 deletions
+1 -1
View File
@@ -6,7 +6,7 @@
title: Talk Documentation
subtitle:
description: >
Documentation and guides for Talk from The Coral Project.
Documentation and guides for Coral by Vox Media
google_analytics: UA-73335347-5
author:
language: en
+1 -1
View File
@@ -10,7 +10,7 @@ smarter discussions around your work.
More than 60 newsrooms use Talk to run their on-site communities, including the Washington Post, the Wall Street Journal, and IGN.
[Read more about our product features and
goals here](https://coralproject.net/talk).
goals here](https://coralproject.net/).
<div class="callout">
We offer hosting and support packages for Talk. [Contact us for more information.](https://coralproject.net/pricing/)
+1 -1
View File
@@ -6,7 +6,7 @@ permalink: /
Online comments are broken. Our open-source commenting platform, Coral, rethinks
how moderation, comment display, and conversation function, creating the
opportunity for safer, smarter discussions around your work.
[Read more about Coral here](https://coralproject.net/talk).
[Read more about Coral here](https://coralproject.net/).
Built with ❤️ by The Coral Project, a part of [Vox Media](https://product.voxmedia.com/).
+5 -1
View File
@@ -39,7 +39,11 @@ You will then have to generate a JWT with the following claims:
authentication system. This is required to facilitate notification email's
about status changes on a user account such as bans or suspensions.
- `user.username` (**required**) - the username that should be used when being
presented inside Coral to moderators and other users.
presented inside Coral to moderators and other users. The following restrictions apply :
- Can only contain letter (`a-zA-Z`), number (`0-9`), underscore (`_`) or period (`.`) characters. Spaces and other special characters are not allowed.
- Min length = 3
- Max length = 30
- `user.badges` (_optional_) - array of strings to be displayed as badges beside
username inside Coral, visible to other users and moderators. For example, to indicate
a user's subscription status.
+1 -1
View File
@@ -1,6 +1,6 @@
<article{% if page.class %} class="{{ page.class }}"{% endif %}>
{% if page.title %}
<a class="btn btn-sm btn-light float-right suggest-edits plain-link" href="https://github.com/coralproject/talk/edit/master/docs/source/{{ page.source }}" title="Suggest edits to this page">Suggest Edits</a>
<a class="btn btn-sm btn-light float-right suggest-edits plain-link" href="https://github.com/coralproject/talk/edit/release/4/docs/source/{{ page.source }}" title="Suggest edits to this page">Suggest Edits</a>
<h1>{{ page.title }}</h1>
<hr/>
{% endif %}
+1 -1
View File
@@ -1,6 +1,6 @@
<hr/>
<footer class="footer">
<p class="text-center">Coral Project Talk Technical Documentation. Design inspired by <a href="https://docs.minio.io/" rel="noreferrer" target="_blank">Minio Docs</a>.</p>
<p class="text-center">Coral by Vox Media Technical Documentation. Design inspired by <a href="https://docs.minio.io/" rel="noreferrer" target="_blank">Minio Docs</a>.</p>
</footer>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script>