From 4c49d6dc880a2de82da20cf247c6de4973468246 Mon Sep 17 00:00:00 2001 From: Kathryn Beaty Date: Wed, 8 Nov 2023 08:19:18 -0500 Subject: [PATCH 1/5] update some links in docs --- docs/docs/administration.md | 4 ++-- docs/docs/comment-embed.md | 4 ++-- docs/docs/css.md | 4 ++-- docs/docs/development.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docs/administration.md b/docs/docs/administration.md index fd7285fd20..f6b3243d8c 100644 --- a/docs/docs/administration.md +++ b/docs/docs/administration.md @@ -47,7 +47,7 @@ There is also a clock icon in the top right of the page. When you click the icon You can set the default language Coral uses in **Admin** > **Configure** > **General**. -You can see what languages Coral currently supports here: https://github.com/coralproject/talk/tree/master/src/locales +You can see what languages Coral currently supports here: https://github.com/coralproject/talk/tree/main/locales ### Comment Stream Settings @@ -138,7 +138,7 @@ Comments containing a word or phrase in the **Suspect Words** List are placed in Lists of words/phrases are not case sensitive, and are separated by new lines. -_Note: occasionally comments are marked "Possible Banned Word" - this happens when the banned word check times out, so we don't know if the comment included a banned word or not. This happens most often in newsrooms that include several thousand banned words on their lists. It should only occur on a small percentage of your comments. We will be fixing this problem in the future, so in the meantime you might try trimming your Banned Word list of words/phrases that seem very unlikely to appear, to reduce the frequency of this issue._ +_Note: occasionally comments are marked "Possible Banned Word" - this happens when the banned word check times out, so we don't know if the comment included a banned word or not. This happens most often in newsrooms that include several thousand banned words on their lists. It should only occur on a small percentage of your comments. We will be fixing this problem in the future, so in the meantime you might try trimming your Banned Word list of words/phrases that seem very unlikely to appear, to reduce the frequency of this issue._ ## Email SMTP Settings diff --git a/docs/docs/comment-embed.md b/docs/docs/comment-embed.md index 13c07da1b9..5c7b55bb70 100644 --- a/docs/docs/comment-embed.md +++ b/docs/docs/comment-embed.md @@ -51,7 +51,7 @@ After successful injection, it includes a shadow dom with the full comment embed Any custom CSS and CSS Font Faces stylesheets that are configured in the `Advanced` admin configuration section will be used to style the comment embed. -The comment embed uses the same [CSS classes](https://github.com/coralproject/talk/blob/develop/src/core/client/stream/classes.ts) that are available to style any comment in the stream. The comment embed also includes a `coral-comment-embed-container` class that can be used to style it specifically. +The comment embed uses the same [CSS classes](https://github.com/coralproject/talk/blob/main/client/src/core/client/stream/classes.ts) that are available to style any comment in the stream. The comment embed also includes a `coral-comment-embed-container` class that can be used to style it specifically. ### Advanced configuration @@ -99,7 +99,7 @@ The simple comment embed html includes the comment's text, comment author's user - embeddedMediaIframeScript -If you are embedding a comment that includes embedded media (Twitter, Youtube, external media image), you will need to add a script to set the correct height for the embed. A message is already being posted via `postMessage` from the embedded media iframe in the Coral comment. An example of how this might be added can be found in `https://github.com/coralproject/talk/tree/develop/src/core/client/oembed/commentEmbed.html`. To support the embedded media height with this iframe script, you will need to attach the comment embed via shadow dom to an element with the id of `coral-comment-embed-shadowRoot-COMMENT_ID`. +If you are embedding a comment that includes embedded media (Twitter, Youtube, external media image), you will need to add a script to set the correct height for the embed. A message is already being posted via `postMessage` from the embedded media iframe in the Coral comment. An example of how this might be added can be found in `https://github.com/coralproject/talk/blob/main/client/src/core/client/oembed/commentEmbed.html`. To support the embedded media height with this iframe script, you will need to attach the comment embed via shadow dom to an element with the id of `coral-comment-embed-shadowRoot-COMMENT_ID`. You will not need to add this script if you are using the Oembed API to add the `simpleCommentEmbedHtml` to your page to work with `commentEmbed.js` injection. The injection script will add the needed iframe script in this case. diff --git a/docs/docs/css.md b/docs/docs/css.md index ac276d31d4..8268405a42 100644 --- a/docs/docs/css.md +++ b/docs/docs/css.md @@ -23,7 +23,7 @@ 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/main/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/client/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. @@ -33,7 +33,7 @@ If you would like to change the styling of any elements of the comment embed, we 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/main/src/core/client/stream/classes.ts to see available stable class names. +You can also navigate to https://github.com/coralproject/talk/blob/main/client/src/core/client/stream/classes.ts to see available stable class names. ### Custom container class for theming diff --git a/docs/docs/development.md b/docs/docs/development.md index ad9c291ec1..d9ee7e06b5 100644 --- a/docs/docs/development.md +++ b/docs/docs/development.md @@ -103,7 +103,7 @@ We’re so proud to have received submissions from a lot of 3rd party contributo translating Coral into their own languages. You can see what languages Coral currently supports here: -https://github.com/coralproject/talk/tree/main/src/locales +https://github.com/coralproject/talk/tree/main/locales Coral uses the [fluent](http://projectfluent.org/) library and store our translations in [FTL](http://projectfluent.org/fluent/guide/) files in From de0307bc8bb53a0891167d4314e1a7a48711c030 Mon Sep 17 00:00:00 2001 From: Kathryn Beaty Date: Wed, 8 Nov 2023 09:22:46 -0500 Subject: [PATCH 2/5] update more docs links --- docs/docs/events.md | 10 +++++----- docs/docs/external-moderation-phases.md | 2 +- docs/docs/faq.md | 6 +++--- docs/docs/notifications.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/events.md b/docs/docs/events.md index 7e8e416175..1924fc3025 100644 --- a/docs/docs/events.md +++ b/docs/docs/events.md @@ -13,11 +13,11 @@ In this example, we’re logging all events to the console as well as sending th ```html