Merge pull request #3630 from coralproject/develop

6.13

docs/docs/administration.md

@@ -20,7 +20,7 @@ These are comments that have been held back by the system for some reason. These
 - The article or site is set to pre-moderate all comments (except for Staff/Moderator/Admin/Expert comments)
 - The commenter has been manually set to 'Always Pre-moderate' by a moderator
 - The comment has been ruled as 'Likely to be toxic' by the AI (optional)
-- The commenter's recent behavior has included a higher percentage of rejected comment than the threshhold you set in Configure ('Recent History') (optional)
+- The commenter's recent behavior has included a higher percentage of rejected comment than the threshold you set in Configure ('Recent History') (optional)
 - The commenter has entered an identical comment twice in a row, anywhere on the site
 - The site is set to hold back for review the first comments by new commenters (optional)
 - The comment is marked as likely to spam by our spam detection system (optional)
@@ -72,7 +72,7 @@ Set a limit on how long commenters have to edit their comments sitewide. Edited
 
 #### **Closing comment streams**
 
-Set comment streams to close after a defined period of time after a story’s publication. When this feature is enabled, existing stories older than the defined period that have not been manually opened or closed will also be updated and set as closed. Manually opening or closing a story will permantenly override the auto-close functionality.
+Set comment streams to close after a defined period of time after a story’s publication. When this feature is enabled, existing stories older than the defined period that have not been manually opened or closed will also be updated and set as closed. Manually opening or closing a story will permanently override the auto-close functionality.
 
 #### **Closed comment stream message**
 
@@ -110,7 +110,7 @@ Prevents repeat offenders from publishing comments without approval. When a comm
 Rejection rate time period determines the look back period of commenter activity that will be considered in performing the calculation.
 
 Rejection rate threshold is calculated by dividing
-number of Rejected comments by (rejected comments + published comments) over the time period specified, and is displayed as a percentage. It does not include comments pending for toxicity, spam or pre-moderation, only moderated comments are considred.
+number of Rejected comments by (rejected comments + published comments) over the time period specified, and is displayed as a percentage. It does not include comments pending for toxicity, spam or pre-moderation, only moderated comments are considered.
 
 ### Toxic Comment Filter
 
@@ -184,4 +184,4 @@ List of domains where your Coral instance is allowed to be embedded. List each d
 
 Advanced settings for how stories are created within Coral; such as if stories are to be automatically created when they are published from your CMS.
 
-See CMS Integration secions [Story Creation](/cms/#story-creation) and [Story Scraping](/cms/#story-scraping) for more details.
+See CMS Integration sections [Story Creation](/cms/#story-creation) and [Story Scraping](/cms/#story-scraping) for more details.

docs/docs/auth.md

@@ -14,7 +14,7 @@ To configure authentication for your instance of Coral, go to **Configure** > **
 
 Best when you want Coral to manage all user registration, creation and authentication. Requires the least amount of setup and configuration. Users register by creating a Username (must be unique across users, no spaces or special chars), Email, and Password. All user details are stored in Coral's database.
 
-By Default - users are sent a verification email and are prompted to verify email addresss, however completing the email verification step is not required to submit comments.
+By default - users are sent a verification email and are prompted to verify their email address, however completing the email verification step is not required to submit comments.
 
 ## Login with OpenID Connect
 
@@ -24,7 +24,7 @@ With OpenID Connect authentication is handled by passing an access token paramet
 
 ## Login with Single Sign On
 
-When you want users to authenticate via your existing identity system, and be automatically registered/logged into Coral. Users register, login, and manage their user details on your existing site, your user database maintains the source of truth for all user information. Users are created and updated in Coral via jwt tokens passed from your auth service to Coral.
+When you want users to authenticate via your existing identity system, and be automatically registered/logged into Coral. Users register, login, and manage their user details on your existing site, your user database maintains the source of truth for all user information. Users are created and updated in Coral via JWT tokens passed from your auth service to Coral.
 
 Requires advanced configuration, please see: [Single Sign On](/sso)
 
@@ -44,7 +44,7 @@ Optional features you can enable or disable to allows users to:
 
 ## Session settings
 
-Determines length of user sessions when not using SSO or when `exp` claim is not provided on jwt. Default: `90 Days`.
+Determines length of user sessions when not using SSO or when `exp` claim is not provided on JWT. Default: `90 Days`.
 
 ## Username Restrictions
 
@@ -54,4 +54,4 @@ Coral usernames are subject to the following validations:
 - USERNAME_MAX_LENGTH = `30`
 - USERNAME_MIN_LENGTH = `3`
 
-_NOTE: SSO users are not subject to username restricitons_
+_NOTE: SSO users are not subject to username restrictions_

docs/docs/cms.md

@@ -10,15 +10,15 @@ With Coral setup and running locally you can find your **Embed code** under **Co
   (function () {
     var d = document,
       s = d.createElement("script");
-    var url = "{{ CORAL_DOMAIN_NAME }}";
-    s.src = "//" + url + "/assets/js/embed.js";
+    var URL = "{{ CORAL_DOMAIN_NAME }}";
+    s.src = "//" + URL + "/assets/js/embed.js";
     s.async = false;
     s.defer = true;
     s.onload = function () {
       Coral.createStreamEmbed({
         id: "coral_thread",
         autoRender: true,
-        rootURL: "//" + url,
+        rootURL: "//" + URL,
       });
     };
     (d.head || d.body).appendChild(s);
@@ -47,7 +47,7 @@ Options object for `createStreamEmbed`:
 
 ## Story Creation
 
-Lazy `Story` Creation enables stories to be automatically created when they are published from your CMS. Triggering the embed script above renders the comment stream iFrame on your page. By default that script dynamically generates `Stories` in Coral for seamless integration.
+Lazy `Story` Creation enables stories to be automatically created when they are published from your CMS. Triggering the embed script above renders the comment stream iframe on your page. By default that script dynamically generates `Stories` in Coral for seamless integration.
 
 ### storyURL
 
@@ -65,11 +65,11 @@ If you do not specify a `storyURL` when rendering the embed, the `storyURL` is f
 </html>
 ```
 
-The url must reference an existing Permitted Domain. If your articles/stories always have unique urls, then you will not need to modify the default behavior.
+The URL must reference an existing Permitted Domain. If your articles/stories always have unique URLs, then you will not need to modify the default behavior.
 
-If this tag is not present, or if the canonical URL references a different url than your site such as a wire service, you can specify the `storyURL` parameter in the render function.
+If this tag is not present, or if the canonical URL references a different URL than your site such as a wire service, you can specify the `storyURL` parameter in the render function.
 
-The url will be used by Coral to build user facing links, and should reference the location where you would direct a user back to this particular story or article.
+The URL will be used by Coral to build user facing links, and should reference the location where you would direct a user back to this particular story or article.
 
 ### storyID
 
@@ -87,7 +87,7 @@ By default, stories have their metadata scraped when they are loaded. This provi
 
 Metadata scraping is performed by the `scraper` job which is enabled by default.
 
-If your production site is behind a paywall or otherwise prevents scraping, you might need to confiugre a **Scraper Proxy URL**. When specified it allows scraping requests to use the provided proxy. All requests are then passed through the appropriote proxy as parsed by the npm proxy-agent package.
+If your production site is behind a paywall or otherwise prevents scraping, you might need to configure a **Scraper Proxy URL**. When specified it allows scraping requests to use the provided proxy. All requests are then passed through the appropriate proxy as parsed by the npm proxy-agent package.
 
 | Asset Property     | Selector                                                                                                                                                            |
 | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

docs/docs/contact.md

@@ -0,0 +1,15 @@
+---
+title: Contact
+---
+
+## How can I get help integrating Coral into my newsroom?
+
+We're here to help with newsrooms of all sizes. Connect with us [here](https://coralproject.net/contact/) to see how we can help you!
+
+## 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.
+
+## 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/main/CONTRIBUTING.md) to get started, but feel free to reach out to us via GitHub, or get in touch with us directly via support@coralproject.net.

docs/docs/counts.md

@@ -39,8 +39,8 @@ After successful injection it will become:
 Set the class of your html element to `coral-count` in order to get story counts. The following `data-coral-*` attributes will configure the output:
 
 - `data-coral-id` – The id of the story of which counts should be injected.
-- `data-coral-url` – The url of the story of which counts should be injected.
+- `data-coral-url` – The URL of the story of which counts should be injected.
 - `data-coral-notext` – If set to `"true"`, only the count number will be injected
 
-Either `data-coral-id` or `data-coral-url` should be set. If none are provided the story url
+Either `data-coral-id` or `data-coral-url` should be set. If none are provided the story URL
 will be retrieved from the [canonical url reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs#Using_%3Clink_relcanonical%3E) `<link rel="canonical" href="...">` or inferred using the current page url.

docs/docs/css.md

@@ -21,17 +21,17 @@ Here is a CSS example that modifies some of the CSS Variables.
 }
 ```
 
-You can find all CSS Variables using the Web Inspector or navigate to https://github.com/coralproject/talk/blob/master/CSS_VARIABLES.md for a comprehensive list and additional information.
+You can find all CSS Variables using the Web Inspector or navigate to https://github.com/coralproject/talk/blob/main/CSS_VARIABLES.md for a comprehensive list and additional information.
 
 > **NOTE:** Before 6.3.0 Coral uses a different set of CSS Variables. Navigate to the link above to get information on upgrading.
 
 ### Use stable CSS Class Names
 
-If you would like to change the styling of any elements of the comment embed, we provide global classnames. Most elements will be tagged with either `.coral` or `.coral-stream`.
+If you would like to change the styling of any elements of the comment embed, we provide global class names. Most elements will be tagged with either `.coral` or `.coral-stream`.
 
-The easiest way to find the classname for the element you're looking for is to use the web inspector, and then update your stylesheet accordingly.
+The easiest way to find the class name for the element you're looking for is to use the web inspector, and then update your stylesheet accordingly.
 
-You can also navigate to https://github.com/coralproject/talk/blob/master/src/core/client/stream/classes.ts to see available stable class names.
+You can also navigate to https://github.com/coralproject/talk/blob/main/src/core/client/stream/classes.ts to see available stable class names.
 
 ### Custom body class for theming
 

docs/docs/development.md

@@ -117,7 +117,7 @@ where the string is used.
 Once a language has enough coverage, it should be added to
 `src/core/common/helpers/i18n/locales.ts`.
 
-The [Perspective API](https://github.com/conversationai/perspectiveapi/blob/master/2-api/methods.md#analyzecomment-request)
+The [Perspective API](https://developers.perspectiveapi.com/s/about-the-api-methods)
 also supports comments in specific languages. When the language is supported in
 Coral and supported by the Perspective API, the language should be added to the
 language map in `src/core/server/services/comments/pipeline/phases/toxic.ts`.

docs/docs/environment-variables.md

@@ -11,7 +11,7 @@ the variables in a `.env` file in the root of the project in a simple
 
 ### `PORT`
 
-The port to listen for HTTP and Websocket requests. (Default `3000`)
+The port to listen for HTTP and WebSocket requests. (Default `3000`)
 
 ### `MONGODB_URI`
 
@@ -95,7 +95,7 @@ instance for at least the next 60 days.
 
 ### `DISABLE_LIVE_UPDATES`
 
-When `true`, the comment stream will not create a websocket connection to get
+When `true`, the comment stream will not create a WebSocket connection to get
 live comment updates. This applies across all tenants on the installation, and
 cannot be turned back on via the interface. (Default `false`)
 
@@ -150,14 +150,14 @@ uses this Coral server on `PORT` as the upstream. Disabled by default.
 ### `TRUST_PROXY`
 
 When provided, it configures the "trust proxy" settings for Express. If you are
-encountering issues where urls in the administration are showing with a `http`
+encountering issues where URLs in the administration are showing with a `http`
 instead of `https`, you may need to set the `TRUST_PROXY` setting. Refer to
 https://expressjs.com/en/guide/behind-proxies.html for possible values of this
 configuration variable as it pertains to your setup.
 
 ### `WEBSOCKET_KEEP_ALIVE_TIMEOUT`
 
-The interval that should be used to send keep alive messages over websocket to
+The interval that should be used to send keep alive messages over WebSocket to
 keep the socket open, parsed by [ms](https://www.npmjs.com/package/ms).
 (Default `30s`)
 

docs/docs/events.md

@@ -18,6 +18,7 @@ In this example, we’re logging all events to the console as well as sending th
         console.log(eventName, data);
         if (eventName === 'createComment.success') {
           my_event_tracker.send('createComment', data);
+        }
       });
     },
   });
@@ -26,4 +27,4 @@ In this example, we’re logging all events to the console as well as sending th
 
 ## Available Events
 
-A complete list of trackable events is available on GitHub: https://github.com/coralproject/talk/blob/master/CLIENT_EVENTS.md
+A complete list of trackable events is available on GitHub: https://github.com/coralproject/talk/blob/main/CLIENT_EVENTS.md

docs/docs/faq.md

@@ -8,11 +8,11 @@ There are a few avenues to get in touch with us and others in the community for
 
 To log a bug or request a feature, submit a Support ticket ([support@coralproject.net](mailto:support@coralproject.net)) and someone from our team will get back to you.
 
-You can also request help on Github by [submitting an issue](https://github.com/coralproject/talk/issues). This also increases your chances of having someone from the community respond to help.
+You can also request help on GitHub by [submitting an issue](https://github.com/coralproject/talk/issues). This also increases your chances of having someone from the community respond to help.
 
 ## How can our dev team contribute to Coral?
 
-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 too.
+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 too.
 
 ## What if we want to add a feature you don't have?
 

docs/docs/ie11.md

@@ -21,7 +21,7 @@ const loadProfileContainer = () =>
 
 ## CSS Calc
 
-Various bugs exists around `calc` support in IE11 (see
+Various bugs exist around `calc` support in IE11 (see
 https://caniuse.com/#feat=calc). We work around most of them by pre-transforming
-`calc` values using `postcss-calc-function`. Some css attributes might have an
+`calc` values using `postcss-calc-function`. Some CSS attributes might have an
 issue if you use `css-variables` inside `calc`.

docs/docs/installation.md

@@ -10,8 +10,8 @@ Online comments are broken. Our open-source commenting platform, Coral,
 reimagines moderation, comment display, and conversation. Use Coral to add
 smarter, safer discussions to your site without giving away your data.
 
-More than 130 newsrooms in 16 countries trust Coral to power their on-site
-communities, including The Washington Post, The Wall Street Journal, and Der
+More than 280 newsrooms in 23 countries trust Coral to power their on-site
+communities, including The Washington Post, The Financial Times, Wired, The Wall Street Journal, and Der
 Spiegel. [Read more about Coral here](https://coralproject.net/).
 
 Built with ❤️ by Coral by [Vox Media](https://product.voxmedia.com/).

docs/docs/migrating-5-to-6.md

@@ -0,0 +1,19 @@
+---
+title: Migrating from v5.x to v6+
+---
+
+Coral 6.0.0 introduces new features to assist with large communities using
+Coral. To migrate from any 5.x.x release, ensure you first upgrade to 5.5.1
+and allow all migrations to run. This means that you cannot upgrade from any
+version below 5.5.1 to 6.0.0 directly.
+
+### Supporting your Migration
+
+We would love to help!
+
+If you’re currently running any open source version 4.x/5.x and would like
+assistance with planning and/or executing a migration please reach out to us at
+support@coralproject.net.
+
+We can help you figure out the best path forward, and give you early access to
+the migration tools we’re working on.