From e86cfaaa5b2dcc74303fb8c1c267cd197d7eef61 Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Mon, 26 Mar 2018 12:52:04 -0600 Subject: [PATCH] docs update --- docs/_config.yml | 2 +- docs/source/01-01-talk-quickstart.md | 6 +- docs/source/01-02-installation-from-docker.md | 6 +- docs/source/01-03-installation-from-source.md | 4 +- docs/source/02-01-required-configuration.md | 4 +- docs/source/02-02-advanced-configuration.md | 67 ++++++++++--------- .../03-01-product-guide-how-talk-works.md | 6 +- .../03-02-product-guide-commenter-features.md | 4 +- .../03-03-product-guide-moderator-features.md | 8 +-- docs/source/03-04-product-guide-trust.md | 2 +- .../03-05-product-guide-toxic-comments.md | 2 +- docs/source/plugins/overview.md | 2 +- docs/themes/coral/layout/partial/sidebar.swig | 2 +- plugins/talk-plugin-toxic-comments/README.md | 2 +- 14 files changed, 60 insertions(+), 57 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index f269d8695..deb14ced4 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -171,7 +171,7 @@ marked: breaks: false smartLists: true smartypants: true - modifyAnchors: '' + modifyAnchors: 1 autolink: true node_sass: diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index 9ab7a50af..c18aea638 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -24,7 +24,7 @@ to persist data. The following versions are supported: An optional dependency for Talk is [Docker](https://www.docker.com/community-edition#/download). -It is used during [development](#development) to set up the database and can be +It is used during development to set up the database and can be used to [install via Docker](#installation-from-docker). We have tested Talk and this documentation with versions 17.06.2+. @@ -80,7 +80,7 @@ volumes: ``` This is the bare minimum needed to run the demo, for more configuration -variables, check out the [Configuration](./configuration/) section. +variables, check out the [Configuration](/talk/configuration/) section. And you can then start it with: @@ -172,7 +172,7 @@ TALK_FACEBOOK_APP_SECRET=A-Facebook-App-Secret ``` This is only the bare minimum needed to run the demo, for more configuration -variables, check out the [Configuration](./configuration/) section. Facebook login above +variables, check out the [Configuration](/talk/configuration/) section. Facebook login above will definitely not work unless you change those values as well. diff --git a/docs/source/01-02-installation-from-docker.md b/docs/source/01-02-installation-from-docker.md index 13e253737..dbf43fb54 100644 --- a/docs/source/01-02-installation-from-docker.md +++ b/docs/source/01-02-installation-from-docker.md @@ -75,7 +75,7 @@ volumes: ``` This is the bare minimum needed to start Talk, for more configuration -variables, check out the [Configuration](./configuration/) section. +variables, check out the [Configuration](/talk/configuration/) section. And you can then start it with: @@ -111,7 +111,7 @@ talk_1 yarn start Up 0.0.0.0:3000->3000/tcp ``` -At this stage, you should refer to the [configuration](./configuration/) for +At this stage, you should refer to the [configuration](/talk/configuration/) for configuration variables that are specific to your installation. ## Onbuild @@ -142,7 +142,7 @@ This accomplishes a lot: 2. Installs any new dependencies that were required by any new plugins. 3. Builds the new static bundles so that they are ready to serve when the image is running. -4. Specifies a build time variable [TALK_DEFAULT_LANG](./advanced-configuration/#talk_default_lang). Refer +4. Specifies a build time variable [TALK_DEFAULT_LANG](/talk/advanced-configuration/#talk-default-lang). Refer to [Dockerfile.onbuild](https://github.com/coralproject/talk/blob/master/Dockerfile.onbuild) for the available build variables. diff --git a/docs/source/01-03-installation-from-source.md b/docs/source/01-03-installation-from-source.md index 8b6f52228..a460751f7 100644 --- a/docs/source/01-03-installation-from-source.md +++ b/docs/source/01-03-installation-from-source.md @@ -62,7 +62,7 @@ TALK_FACEBOOK_APP_SECRET=A-Facebook-App-Secret ``` This is the bare minimum needed to start Talk, for more configuration -variables, check out the [Configuration](./configuration/) +variables, check out the [Configuration](/talk/configuration/) section. Facebook login above will definitely not work unless you change those values as well. @@ -73,5 +73,5 @@ You can now start the application by running: yarn watch:server ``` -At this stage, you should refer to the [configuration](./configuration/) for +At this stage, you should refer to the [configuration](/talk/configuration/) for configuration variables that are specific to your installation. diff --git a/docs/source/02-01-required-configuration.md b/docs/source/02-01-required-configuration.md index 1bfaa361c..be1e1d0b2 100644 --- a/docs/source/02-01-required-configuration.md +++ b/docs/source/02-01-required-configuration.md @@ -16,7 +16,7 @@ instance of Talk. If you've already configured your application with the required configuration, you can further customize it's behavior by applying -[Advanced Configuration](./advanced-configuration/). +[Advanced Configuration](/talk/advanced-configuration/). ## TALK_MONGO_URL @@ -81,4 +81,4 @@ TALK_JWT_SECRET=jX9y8G2ApcVLwyL{$6s3 Be default, we sign our tokens with HMAC using a SHA-256 hash algorithm. If you want to change the signing algorithm, or use multiple signing/verifying keys, -refer to our [Advanced Configuration](./advanced-configuration/) documentation. +refer to our [Advanced Configuration](/talk/advanced-configuration/) documentation. diff --git a/docs/source/02-02-advanced-configuration.md b/docs/source/02-02-advanced-configuration.md index 458efe8d7..30bc5c69b 100644 --- a/docs/source/02-02-advanced-configuration.md +++ b/docs/source/02-02-advanced-configuration.md @@ -15,7 +15,7 @@ The variables above have defaults, and are _optional_ to start your instance of Talk. If this is your first time configuring Talk, ensure you've also added the -[Required Configuration](./configuration) as well, +[Required Configuration](/talk/configuration) as well, otherwise the application will fail to start. ## TALK_CACHE_EXPIRY_COMMENT_COUNT @@ -26,7 +26,7 @@ Configure the duration for which comment counts are cached for, parsed by ## TALK_DEFAULT_LANG This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild](./installation-from-docker/#onbuild) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_DEFAULT_LANG=en`. Specify the default translation language. (Default `en`) @@ -34,7 +34,7 @@ Specify the default translation language. (Default `en`) ## TALK_DEFAULT_STREAM_TAB This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild](./installation-from-docker/#onbuild) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_DEFAULT_STREAM_TAB=all`. Specify the default stream tab in the admin. (Default `all`) @@ -53,7 +53,7 @@ in the embed.js target that is loaded on the page that loads the embed. (Default ## TALK_DISABLE_STATIC_SERVER When `TRUE`, it will not mount the static asset serving routes on the router. -This is used primarily in conjunction with [TALK_STATIC_URI](#talk_static_uri) +This is used primarily in conjunction with [TALK_STATIC_URI](#talk-static-uri) when the static assets are being hosted on an external domain. (Default `FALSE`) ## TALK_HELMET_CONFIGURATION @@ -149,7 +149,7 @@ claim for login JWT tokens. (Default `talk`) ## TALK_JWT_CLEAR_COOKIE_LOGOUT When `FALSE`, Talk will not clear the cookie with name -[TALK_JWT_SIGNING_COOKIE_NAME](#talk_jwt_signing_cookie_name) when logging out +[TALK_JWT_SIGNING_COOKIE_NAME](#talk-jwt-signing-cookie-name) when logging out but will still blacklist the token. (Default `TRUE`) ## TALK_JWT_COOKIE_NAME @@ -160,8 +160,8 @@ user. (Default `authorization`) ## TALK_JWT_COOKIE_NAMES The different cookie names to check for a JWT token in, separated by a `,`. By -default, we always use the value of [TALK_JWT_COOKIE_NAME](#talk_jwt_cookie_name) -and [TALK_JWT_SIGNING_COOKIE_NAME](#talk_jwt_signing_cookie_name) for this +default, we always use the value of [TALK_JWT_COOKIE_NAME](#talk-jwt-cookie-name) +and [TALK_JWT_SIGNING_COOKIE_NAME](#talk-jwt-signing-cookie-name) for this value. Any additional cookie names specified here will be appended to the list of cookie names to inspect. @@ -183,13 +183,13 @@ Would mean we would check the following cookies (in order) for a valid token: When `TRUE`, Talk will not verify or sign JWT’s with an audience [aud](https://tools.ietf.org/html/rfc7519#section-4.1.3) -claim, even if [TALK_JWT_AUDIENCE](#talk_jwt_audience) is set. (Default `FALSE`) +claim, even if [TALK_JWT_AUDIENCE](#talk-jwt-audience) is set. (Default `FALSE`) ## TALK_JWT_DISABLE_ISSUER When `TRUE`, Talk will not verify or sign JWT’s with an issuer [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) -claim, even if [TALK_JWT_ISSUER](#talk_jwt_issuer) is set. (Default `FALSE`) +claim, even if [TALK_JWT_ISSUER](#talk-jwt-issuer) is set. (Default `FALSE`) ## TALK_JWT_EXPIRY @@ -205,7 +205,7 @@ reason to create reasonable expiry lengths as to minimize the storage overhead. ## TALK_JWT_ISSUER The issuer [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) -claim for login JWT tokens. (Defaults to value of [TALK_ROOT_URL](./configuration/#talk_root_url)) +claim for login JWT tokens. (Defaults to value of [TALK_ROOT_URL](/talk/configuration/#talk-root-url)) ## TALK_JWT_SECRET @@ -223,22 +223,25 @@ You can also express this secret in the JSON syntax: TALK_JWT_SECRET={"secret": "jX9y8G2ApcVLwyL{$6s3"} ``` -Refer to the documentation for [TALK_JWT_ALG](#talk_jwt_alg) for other signing +Refer to the documentation for [TALK_JWT_ALG](#talk-jwt-alg) for other signing methods and other forms of the `TALK_JWT_SECRET`. If you are interested in using -multiple keys, then refer to [TALK_JWT_SECRETS](#talk_jwt_secrets). +multiple keys, then refer to [TALK_JWT_SECRETS](#talk-jwt-secrets). ## TALK_JWT_SECRETS Used when specifying multiple secrets used for key rotations. This is a JSON encoded array, where each element matches the JWT Secret pattern. When this is -used, you do not need to specify a [TALK_JWT_SECRET](#talk_jwt_secret) as this +used, you do not need to specify a [TALK_JWT_SECRET](#talk-jwt-secret) as this will take precedence. **The first secret in `TALK_JWT_SECRETS` will be used for signing, and must contain a private key if used with an asymmetric algorithm.** All secrets should specify a `kid` field which uniquely identifies a given key -and will sign all tokens with that `kid` for later identification. +and will sign all tokens with that `kid` for later identification. _If a token +is not signed with the `kid` field in the header, and multiple secrets are used, +the token will fail to be verified. This field must match what's provided to +Talk in the form of the `kid` field in the secret._ -When the value of [TALK_JWT_ALG](#talk_jwt_alg) is a `HS*` value, then the value +When the value of [TALK_JWT_ALG](#talk-jwt-alg) is a `HS*` value, then the value of the `TALK_JWT_SECRETS` should take the form: ```plain @@ -247,24 +250,24 @@ TALK_JWT_SECRETS=[{"kid": "1", "secret": "my-super-secret"}, {"kid": "2", "secre Note that the secret is stored in a JSON object, keyed by `secret`. This is only needed when specifying in the multiple secrets for `TALK_JWT_SECRETS`, but may -be used to specify the single [TALK_JWT_SECRET](#talk_jwt_secret). +be used to specify the single [TALK_JWT_SECRET](#talk-jwt-secret). -When the value of [TALK_JWT_ALG](#talk_jwt_alg) is **not** a `HS*` value, then +When the value of [TALK_JWT_ALG](#talk-jwt-alg) is **not** a `HS*` value, then the value of the `TALK_JWT_SECRETS` should take the form: ```plain TALK_JWT_SECRETS=[{"kid": "1", "private": "", "public": ""}, ...] ``` -Refer to the documentation on the [TALK_JWT_ALG](#talk_jwt_alg) for more +Refer to the documentation on the [TALK_JWT_ALG](#talk-jwt-alg) for more information on what to store in these parameters. ## TALK_JWT_SIGNING_COOKIE_NAME The default cookie name that is use to set a cookie containing a JWT that was -issued by Talk. (Defaults to value of [TALK_JWT_COOKIE_NAME](#talk_jwt_cookie_name)) +issued by Talk. (Defaults to value of [TALK_JWT_COOKIE_NAME](#talk-jwt-cookie-name)) ## TALK_JWT_USER_ID_CLAIM @@ -298,8 +301,8 @@ the websocket to keep the socket alive, parsed by Setting a reCAPTCHA Public and Secret key will enable and require reCAPTCHA upon multiple failed login attempts. Client secret used for enabling reCAPTCHA powered logins. If -[TALK_RECAPTCHA_SECRET](#talk_recaptcha_secret) and -[TALK_RECAPTCHA_PUBLIC](#talk_recaptcha_public) are not provided it will instead +[TALK_RECAPTCHA_SECRET](#talk-recaptcha-secret) and +[TALK_RECAPTCHA_PUBLIC](#talk-recaptcha-public) are not provided it will instead default to providing only a time based lockout. Refer to [reCAPTCHA](https://www.google.com/recaptcha/intro/index.html) for information on getting an account setup. @@ -307,8 +310,8 @@ on getting an account setup. ## TALK_RECAPTCHA_SECRET Server secret used for enabling reCAPTCHA powered logins. If -[TALK_RECAPTCHA_SECRET](#talk_recaptcha_secret) and -[TALK_RECAPTCHA_PUBLIC](#talk_recaptcha_public) are not provided it will instead +[TALK_RECAPTCHA_SECRET](#talk-recaptcha-secret) and +[TALK_RECAPTCHA_PUBLIC](#talk-recaptcha-public) are not provided it will instead default to providing only a time based lockout. Refer to [reCAPTCHA](https://www.google.com/recaptcha/intro/index.html) for information on getting an account setup. @@ -347,7 +350,7 @@ by [ms](https://www.npmjs.com/package/ms). (Default `1 sec`) ## TALK_ROOT_URL_MOUNT_PATH When set to `TRUE`, the routes will be mounted onto the `` component -of the [TALK_ROOT_URL](./configuration/#talk_root_url). +of the [TALK_ROOT_URL](/talk/configuration/#talk-root-url). You would use this when your upstream proxy cannot strip the prefix from the url. (Default `FALSE`) @@ -395,12 +398,12 @@ Used to set the uri where the static assets should be served from. This is used when you want to upload the static assets through your build process to a service like Google Cloud Storage or Amazon S3 and you would then specify the CDN/Storage url. (Defaults to value of -[TALK_ROOT_URL](./configuration/#talk_root_url)) +[TALK_ROOT_URL](/talk/configuration/#talk-root-url)) ## TALK_THREADING_LEVEL This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild](./installation-from-docker/#onbuild) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_THREADING_LEVEL=3`. Specify the maximum depth of the comment thread. (Default `3`) @@ -414,13 +417,13 @@ Used to override the location to connect to the websocket endpoint to potentially another host. This should be used when you need to route websocket requests out of your CDN in order to serve traffic more efficiently. -If the value of [TALK_ROOT_URL](./configuration/#talk_root_url) +If the value of [TALK_ROOT_URL](/talk/configuration/#talk-root-url) is a https url, then this defaults to `wss://${location.host}${MOUNT_PATH}api/v1/live`. Otherwise, it defaults to `ws://${location.host}${MOUNT_PATH}api/v1/live`. -Where `MOUNT_PATH` is either `/` if [TALK_ROOT_URL_MOUNT_PATH](#talk_root_url_mount_path) +Where `MOUNT_PATH` is either `/` if [TALK_ROOT_URL_MOUNT_PATH](#talk-root-url-mount-path) is `FALSE`, or the path component of -[TALK_ROOT_URL](./configuration/#talk_root_url) if it's `TRUE`. +[TALK_ROOT_URL](/talk/configuration/#talk-root-url) if it's `TRUE`. **Warning: if used without managing the auth state manually, auth cannot be persisted due to browser restrictions.** @@ -491,7 +494,7 @@ be used with caution. (Default `FALSE`) ## TALK_ADDTL_COMMENTS_ON_LOAD_MORE This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild]({{ "/installation-from-docker/#onbuild" | relative_url }}) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_ADDTL_COMMENTS_ON_LOAD_MORE=10`. Specifies the number of additional comments to load when a user clicks `Load More`. (Default `10`) @@ -499,7 +502,7 @@ Specifies the number of additional comments to load when a user clicks `Load Mor ## TALK_ASSET_COMMENTS_LOAD_DEPTH This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild]({{ "/installation-from-docker/#onbuild" | relative_url }}) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_ASSET_COMMENTS_LOAD_DEPTH=10`. Specifies the initial number of comments to load for an asset. (Default `10`) @@ -507,7 +510,7 @@ Specifies the initial number of comments to load for an asset. (Default `10`) ## TALK_REPLY_COMMENTS_LOAD_DEPTH This is a **Build Variable** and must be consumed during build. If using the -[Docker-onbuild]({{ "/installation-from-docker/#onbuild" | relative_url }}) +[Docker-onbuild](/talk/installation-from-docker/#onbuild) image you can specify it with `--build-arg TALK_REPLY_COMMENTS_LOAD_DEPTH=3`. Specifies the initial replies to load for a comment. (Default `3`) diff --git a/docs/source/03-01-product-guide-how-talk-works.md b/docs/source/03-01-product-guide-how-talk-works.md index fa27e5ed0..9463f74fe 100644 --- a/docs/source/03-01-product-guide-how-talk-works.md +++ b/docs/source/03-01-product-guide-how-talk-works.md @@ -28,13 +28,13 @@ Plugins are additional functionality which are optional to use with Talk. You can turn these on or off, depending on your specific needs. Plugins are either part of our core plugins, which ship with Talk, or they are developed by 3rd parties and either used privately and internally, or are open sourced for use -across the greater community. You can explore the plugins we offer by visiting our [Default Plugins](./default-plugins/) -and [Additional Plugins](./additional-plugins/) pages. +across the greater community. You can explore the plugins we offer by visiting our [Default Plugins](/talk/default-plugins/) +and [Additional Plugins](/talk/additional-plugins/) pages. ## Recipes Recipes are plugin templates that are created by the Talk team and 3rd party developers, in order to help contributors and newsrooms build plugins easily. -You can explore the recipes we offer by visiting our [Plugin Recipes](./plugin-recipes/) +You can explore the recipes we offer by visiting our [Plugin Recipes](/talk/plugin-recipes/) page. diff --git a/docs/source/03-02-product-guide-commenter-features.md b/docs/source/03-02-product-guide-commenter-features.md index 1c432303a..390fdce50 100644 --- a/docs/source/03-02-product-guide-commenter-features.md +++ b/docs/source/03-02-product-guide-commenter-features.md @@ -31,7 +31,7 @@ https://?commentId= Talk supports by default 3 levels of threading, meaning each top-level comment has a depth of 3 replies; replies beyond that are not nested below the 3rd level. You can adjust this using the -[TALK_THREADING_LEVEL](./advanced-configuration/#talk_threading_level) +[TALK_THREADING_LEVEL](/talk/advanced-configuration/#talk-threading-level) configuration variable. We don’t recommend deep threading because it can cause issues with styling, especially on mobile. @@ -162,7 +162,7 @@ Staff role. The Featured comment badge shows when a comment has been featured. Another optional badge is the Subscriber badge (which is available as a -[Recipe](./plugin-recipes/#recipe-subscriber). +[Recipe](/talk/plugin-recipes/#recipe-subscriber). Badges are another easy part of Talk to customize by creating a new `tag`, then setting some rules for when it should show, and how the badge should be styled. diff --git a/docs/source/03-03-product-guide-moderator-features.md b/docs/source/03-03-product-guide-moderator-features.md index 44f5605b4..9fbda6a18 100644 --- a/docs/source/03-03-product-guide-moderator-features.md +++ b/docs/source/03-03-product-guide-moderator-features.md @@ -56,8 +56,8 @@ history. **Toxic** The Toxic badge signifies comments that are above the set Toxicity Probability -Threshold. Note you must have [talk-plugin-toxic-comments](./additional-plugins/#talk-plugin-toxic-comments) enabled. -[Read more about Toxic Comments here](./toxic-comments/). +Threshold. Note you must have [talk-plugin-toxic-comments](/talk/additional-plugins/#talk-plugin-toxic-comments) enabled. +[Read more about Toxic Comments here](/talk/toxic-comments/). **Suspect** @@ -122,7 +122,7 @@ automatically. **Reports** This shows if a commenter is a reliable flagger, an unreliable flagger, or a -neutral flagger. [Read more about reliable and unreliable flaggers here](./trust/#reliable-and-unreliable-flaggers). +neutral flagger. [Read more about reliable and unreliable flaggers here](/talk/trust/#reliable-and-unreliable-flaggers). **Moderating from this View** @@ -173,7 +173,7 @@ manage your team members’ roles (Admins, Moderators, Staff), as well as search for commenters and take action on them (e.g. Ban/Un-ban, Suspend, etc.). ### Configure -See [Configuring Talk](./configuring-talk/). +See [Configuring Talk](/talk/configuring-talk/). ## Moderating via the Comment Stream diff --git a/docs/source/03-04-product-guide-trust.md b/docs/source/03-04-product-guide-trust.md index bea080716..c27c59dcc 100644 --- a/docs/source/03-04-product-guide-trust.md +++ b/docs/source/03-04-product-guide-trust.md @@ -28,7 +28,7 @@ Here are the default thresholds: +3 and higher: Reliable ``` -You can configure your own Trust thresholds by using [TRUST_THRESHOLD](./advanced-configuration/#trust_thresholds) in your +You can configure your own Trust thresholds by using [TRUST_THRESHOLD](/talk/advanced-configuration/#trust-thresholds) in your configuration. diff --git a/docs/source/03-05-product-guide-toxic-comments.md b/docs/source/03-05-product-guide-toxic-comments.md index 3d52bfe22..ddbb4f9ff 100644 --- a/docs/source/03-05-product-guide-toxic-comments.md +++ b/docs/source/03-05-product-guide-toxic-comments.md @@ -50,7 +50,7 @@ trying to improve a broken part of the internet. ## How do I add the Toxic Comments plugin? To enable this behavior, visit the -[talk-plugin-toxic-comments](./additional-plugins/#talk-plugin-toxic-comments) +[talk-plugin-toxic-comments](/talk/additional-plugins/#talk-plugin-toxic-comments) plugin documentation. diff --git a/docs/source/plugins/overview.md b/docs/source/plugins/overview.md index 03bb8dcee..26230dc00 100644 --- a/docs/source/plugins/overview.md +++ b/docs/source/plugins/overview.md @@ -116,4 +116,4 @@ configuration and will ensure that the image is ready to use by building all assets inside the image as well. For more information on the onbuild image, refer to the -[Installation from Docker](./installation-from-docker/) documentation. +[Installation from Docker](/talk/installation-from-docker/) documentation. diff --git a/docs/themes/coral/layout/partial/sidebar.swig b/docs/themes/coral/layout/partial/sidebar.swig index d6d4fbab1..9d0a335d6 100644 --- a/docs/themes/coral/layout/partial/sidebar.swig +++ b/docs/themes/coral/layout/partial/sidebar.swig @@ -17,7 +17,7 @@ diff --git a/plugins/talk-plugin-toxic-comments/README.md b/plugins/talk-plugin-toxic-comments/README.md index efd5f550a..60c05ad9f 100644 --- a/plugins/talk-plugin-toxic-comments/README.md +++ b/plugins/talk-plugin-toxic-comments/README.md @@ -12,7 +12,7 @@ plugin: Using the [Perspective API](http://perspectiveapi.com/), this plugin will warn users and reject comments that exceed the predefined toxicity threshold. For more information on what Toxic Comments are, check out the -[Toxic Comments](./toxic-comments/) documentation. +[Toxic Comments](/talk/toxic-comments/) documentation. Configuration: