From 0af28edbd9ad19070c1774e3fbc6e4bc31b39249 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 20 Sep 2019 12:31:20 -0700 Subject: [PATCH] fixed broken links, added username restrictions, minor docs updates (#2580) --- docs/_config.yml | 2 +- docs/source/01-01-talk-quickstart.md | 2 +- docs/source/version-5-installation.md | 2 +- docs/source/version-5-sso.md | 6 +++++- docs/themes/coral/layout/page.swig | 2 +- docs/themes/coral/layout/partial/footer.swig | 2 +- 6 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 174ca2005..ace01188c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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 diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index b318666d2..67aba8394 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -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/).
We offer hosting and support packages for Talk. [Contact us for more information.](https://coralproject.net/pricing/) diff --git a/docs/source/version-5-installation.md b/docs/source/version-5-installation.md index d259188cf..90267ddec 100644 --- a/docs/source/version-5-installation.md +++ b/docs/source/version-5-installation.md @@ -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/). diff --git a/docs/source/version-5-sso.md b/docs/source/version-5-sso.md index 772800d4b..0622da62d 100644 --- a/docs/source/version-5-sso.md +++ b/docs/source/version-5-sso.md @@ -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. diff --git a/docs/themes/coral/layout/page.swig b/docs/themes/coral/layout/page.swig index 36ebe1509..7b8dc8298 100644 --- a/docs/themes/coral/layout/page.swig +++ b/docs/themes/coral/layout/page.swig @@ -1,6 +1,6 @@ {% if page.title %} - Suggest Edits + Suggest Edits

{{ page.title }}

{% endif %} diff --git a/docs/themes/coral/layout/partial/footer.swig b/docs/themes/coral/layout/partial/footer.swig index c8e8fa05d..d38e437b8 100644 --- a/docs/themes/coral/layout/partial/footer.swig +++ b/docs/themes/coral/layout/partial/footer.swig @@ -1,6 +1,6 @@
-

Coral Project Talk Technical Documentation. Design inspired by Minio Docs.

+

Coral by Vox Media Technical Documentation. Design inspired by Minio Docs.