From 06d0da9286ec05a060653742e525757a2a30f7fe Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Fri, 13 Oct 2017 15:50:13 +0100 Subject: [PATCH] Reorganize file order and reinstate h2s --- docs/_docs/02-01-required-configuration.md | 12 +-- docs/_docs/02-02-advanced-configuration.md | 82 +++++++++---------- ... => 03-01-product-guide-how-talk-works.md} | 0 .../03-02-product-guide-commenter-features.md | 4 + .../03-03-product-guide-moderator-features.md | 4 + ...-trust.md => 03-04-product-guide-trust.md} | 0 ... => 03-05-product-guide-toxic-comments.md} | 0 ...-overview.md => 04-01-plugins-overview.md} | 0 ...lt-plugins.md => 04-02-default-plugins.md} | 36 ++++---- ...plugins.md => 04-03-additional-plugins.md} | 20 ++--- ...gin-recipes.md => 04-04-plugin-recipes.md} | 8 +- docs/_sass/talk.scss | 3 - 12 files changed, 85 insertions(+), 84 deletions(-) rename docs/_docs/{04-01-product-guide-how-talk-works.md => 03-01-product-guide-how-talk-works.md} (100%) create mode 100644 docs/_docs/03-02-product-guide-commenter-features.md create mode 100644 docs/_docs/03-03-product-guide-moderator-features.md rename docs/_docs/{04-02-product-guide-trust.md => 03-04-product-guide-trust.md} (100%) rename docs/_docs/{04-03-product-guide-toxic-comments.md => 03-05-product-guide-toxic-comments.md} (100%) rename docs/_docs/{03-01-plugins-overview.md => 04-01-plugins-overview.md} (100%) rename docs/_docs/{03-02-default-plugins.md => 04-02-default-plugins.md} (92%) rename docs/_docs/{03-03-additional-plugins.md => 04-03-additional-plugins.md} (93%) rename docs/_docs/{03-04-plugin-recipes.md => 04-04-plugin-recipes.md} (95%) diff --git a/docs/_docs/02-01-required-configuration.md b/docs/_docs/02-01-required-configuration.md index 84a7236db..dc09a1707 100644 --- a/docs/_docs/02-01-required-configuration.md +++ b/docs/_docs/02-01-required-configuration.md @@ -19,7 +19,7 @@ If you've already configured your application with the required configuration, you can further customize it's behavior by applying [Advanced Configuration]({{ "/advanced-configuration/" | relative_url }}). -### TALK_MONGO_URL +## TALK_MONGO_URL The database connection string for the MongoDB database. This usually takes the form of: @@ -31,7 +31,7 @@ TALK_MONGO_URL=mongodb://:@:` component of the [TALK_ROOT_URL]({{ "/configuration/#talk_root_url" | relative_url }}){: .param}. @@ -361,7 +361,7 @@ Then all the routes for the API will be expecting to be hit on `/talk/`, such as can perform the path stripping when serving an upstream proxy, but some CDN's cannot. You would use this option in the latter situation. -### TALK_SMTP_EMAIL +## TALK_SMTP_EMAIL The email address to send emails from using the SMTP provider in the format: @@ -371,23 +371,23 @@ TALK_SMTP_EMAIL="The Coral Project" Including the name and email address. -### TALK_SMTP_HOST +## TALK_SMTP_HOST The domain for the SMTP provider that you are using. -### TALK_SMTP_PASSWORD +## TALK_SMTP_PASSWORD The password for the SMTP provider you are using. -### TALK_SMTP_PORT +## TALK_SMTP_PORT The port for the SMTP provider that you are using. -### TALK_SMTP_USERNAME +## TALK_SMTP_USERNAME The username of the SMTP provider you are using. -### TALK_STATIC_URI +## TALK_STATIC_URI 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 @@ -395,14 +395,14 @@ 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" | relative_url }}){: .param}) -### TALK_THREADING_LEVEL +## TALK_THREADING_LEVEL Specify the maximum depth of the comment thread. (Default `3`) **Note that a high value for `TALK_THREADING_LEVEL` will result in large performance impacts.** -### TALK_WEBSOCKET_LIVE_URI +## TALK_WEBSOCKET_LIVE_URI 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 @@ -419,7 +419,7 @@ is `FALSE`, or the path component of **Warning: if used without managing the auth state manually, auth cannot be persisted due to browser restrictions.** -### TRUST_THRESHOLDS +## TRUST_THRESHOLDS Configure the reliability thresholds for flagging and commenting. (Default `comment:2,-1;flag:2,-1`) diff --git a/docs/_docs/04-01-product-guide-how-talk-works.md b/docs/_docs/03-01-product-guide-how-talk-works.md similarity index 100% rename from docs/_docs/04-01-product-guide-how-talk-works.md rename to docs/_docs/03-01-product-guide-how-talk-works.md diff --git a/docs/_docs/03-02-product-guide-commenter-features.md b/docs/_docs/03-02-product-guide-commenter-features.md new file mode 100644 index 000000000..8fde0f0ac --- /dev/null +++ b/docs/_docs/03-02-product-guide-commenter-features.md @@ -0,0 +1,4 @@ +--- +title: Commenter Features +permalink: /commenter-features/ +--- diff --git a/docs/_docs/03-03-product-guide-moderator-features.md b/docs/_docs/03-03-product-guide-moderator-features.md new file mode 100644 index 000000000..355c40a1c --- /dev/null +++ b/docs/_docs/03-03-product-guide-moderator-features.md @@ -0,0 +1,4 @@ +--- +title: Moderator Features +permalink: /moderator-features/ +--- diff --git a/docs/_docs/04-02-product-guide-trust.md b/docs/_docs/03-04-product-guide-trust.md similarity index 100% rename from docs/_docs/04-02-product-guide-trust.md rename to docs/_docs/03-04-product-guide-trust.md diff --git a/docs/_docs/04-03-product-guide-toxic-comments.md b/docs/_docs/03-05-product-guide-toxic-comments.md similarity index 100% rename from docs/_docs/04-03-product-guide-toxic-comments.md rename to docs/_docs/03-05-product-guide-toxic-comments.md diff --git a/docs/_docs/03-01-plugins-overview.md b/docs/_docs/04-01-plugins-overview.md similarity index 100% rename from docs/_docs/03-01-plugins-overview.md rename to docs/_docs/04-01-plugins-overview.md diff --git a/docs/_docs/03-02-default-plugins.md b/docs/_docs/04-02-default-plugins.md similarity index 92% rename from docs/_docs/03-02-default-plugins.md rename to docs/_docs/04-02-default-plugins.md index ab843f21b..aff17ebcc 100644 --- a/docs/_docs/03-02-default-plugins.md +++ b/docs/_docs/04-02-default-plugins.md @@ -16,7 +16,7 @@ Talk that are not enabled by default. You can enable these or disable these default plugins by consulting the [Plugins Overview]({{ "/plugins/" | relative_url }}) page. -### talk-plugin-auth +## talk-plugin-auth Source: [plugins/talk-plugin-auth](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-auth){:target="_blank"} @@ -24,7 +24,7 @@ Enables generic registration via an email address, a username, a password, and a password confirmation. To sync Talk auth with your own auth systems, you can use this plugin as a template. -### talk-plugin-facebook-auth +## talk-plugin-facebook-auth Source: [plugins/talk-plugin-auth](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-auth){:target="_blank"} @@ -34,12 +34,10 @@ Enables sign-in via Facebook via the server side passport middleware. Configuration: -{:.no_toc} - - [TALK_FACEBOOK_APP_ID]({{ "/configuration/#talk_facebook_app_id" | relative_url }}){:.param} (**required**) - See the existing documentation for the [TALK_FACEBOOK_APP_ID]({{ "/configuration/#talk_facebook_app_id" | relative_url }}){:.param}. - [TALK_FACEBOOK_APP_SECRET]({{ "/configuration/#talk_facebook_app_secret" | relative_url }}){:.param} (**required**) - See the existing documentation for the [TALK_FACEBOOK_APP_SECRET]({{ "/configuration/#talk_facebook_app_secret" | relative_url }}){:.param}. -### talk-plugin-featured-comments +## talk-plugin-featured-comments Source: [plugins/talk-plugin-featured-comments](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-featured-comments){:target="_blank"} @@ -47,14 +45,14 @@ Enables the ability for Moderators to feature and un-feature comments via the Stream and the Admin. Featured comments show in a first-place tab on the Stream if there are any featured comments on that story. -### talk-plugin-respect +## talk-plugin-respect Source: [plugins/talk-plugin-respect](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-respect){:target="_blank"} Enables a `respect` reaction button. Why a "respect" button, you ask? [Read more here](https://mediaengagement.org/research/engagement-buttons/). -### talk-plugin-comment-content +## talk-plugin-comment-content Source: [plugins/talk-plugin-comment-content](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-comment-content){:target="_blank"} @@ -62,7 +60,7 @@ Pluginizes the text of a comment to support custom treatment of this text. This plugin currently parses the given text to see if it contains a link, and makes them clickable. -### talk-plugin-ignore-user +## talk-plugin-ignore-user Source: [plugins/talk-plugin-ignore-user](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-ignore-user){:target="_blank"} @@ -70,20 +68,20 @@ Enables ability for users to ignore (or "mute") other users. If a user is ignored, you will not see any of their comments. You can un-ignore a user via the My Profile tab. -### talk-plugin-permalink +## talk-plugin-permalink Source: [plugins/talk-plugin-permalink](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-permalink){:target="_blank"} Enables a `Link` button that will provide a permalink to the comment that can be shared with others. -### talk-plugin-viewing-options +## talk-plugin-viewing-options Source: [plugins/talk-plugin-viewing-options](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-viewing-options){:target="_blank"} Pluginizes the sorting/viewing options for a comment stream. -### talk-plugin-sort-newest +## talk-plugin-sort-newest Source: [plugins/talk-plugin-sort-newest](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-newest){:target="_blank"} @@ -92,7 +90,7 @@ Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options){:.param} Provides a sort for the newest comments first. This isn't necessarily required as the default sort without options/plugins is newest first. -### talk-plugin-sort-oldest +## talk-plugin-sort-oldest Source: [plugins/talk-plugin-sort-oldest](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-oldest){:target="_blank"} @@ -100,7 +98,7 @@ Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options){:.param} Provides a sort for the newest comments first. -### talk-plugin-most-respected +## talk-plugin-most-respected Source: [plugins/talk-plugin-most-respected](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-most-respected){:target="_blank"} @@ -108,7 +106,7 @@ Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options){:.param}, Provides a sort for the comments with the most `respect` reactions first. -### talk-plugin-most-replied +## talk-plugin-most-replied Source: [plugins/talk-plugin-most-replied](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-most-replied){:target="_blank"} @@ -116,20 +114,20 @@ Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options){:.param} Provides a sort for the comments with the most replies first. -### talk-plugin-offtopic +## talk-plugin-offtopic Source: [plugins/talk-plugin-offtopic](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-offtopic){:target="_blank"} Allows the comment authors to tag their comment as `Off-Topic` which will add a visible badge on the frontend to other users that their comment is off-topic. -### talk-plugin-author-menu +## talk-plugin-author-menu Source: [plugins/talk-plugin-author-menu](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-author-menu){:target="_blank"} Pluginizes the author's name on hover. -### talk-plugin-member-since +## talk-plugin-member-since Source: [plugins/talk-plugin-member-since](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-member-since){:target="_blank"} @@ -137,14 +135,14 @@ Requires: [talk-plugin-author-menu](#talk-plugin-author-menu){:.param} Displays the date that the user was created as a `Member Since ${created_at}`. -### talk-plugin-moderation-actions +## talk-plugin-moderation-actions Source: [plugins/talk-plugin-moderation-actions](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-moderation-actions){:target="_blank"} Enables in-stream moderation so that Moderators can reject, approve comments, as well as ban users, directly from the comment stream. When [talk-plugin-featured-comments](#talk-plugin-featured-comments){:.param} is enabled -### talk-plugin-flag-details +## talk-plugin-flag-details Source: [plugins/talk-plugin-flag-details](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-flag-details){:target="_blank"} diff --git a/docs/_docs/03-03-additional-plugins.md b/docs/_docs/04-03-additional-plugins.md similarity index 93% rename from docs/_docs/03-03-additional-plugins.md rename to docs/_docs/04-03-additional-plugins.md index 9be7f1cd2..55ab1749b 100644 --- a/docs/_docs/03-03-additional-plugins.md +++ b/docs/_docs/04-03-additional-plugins.md @@ -11,13 +11,13 @@ Talk ships with several plugins that aren't enabled by default: These plugins can be enabled by consulting the [Plugins Overview]({{ "/plugins/" | relative_url }}) page. -### talk-plugin-like +## talk-plugin-like Source: [plugins/talk-plugin-like](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-like){:target="_blank"} Enables a `like` reaction button. -### talk-plugin-sort-most-liked +## talk-plugin-sort-most-liked Source: [plugins/talk-plugin-sort-most-liked](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-liked){:target="_blank"} @@ -25,13 +25,13 @@ Requires: [talk-plugin-viewing-options]({{ "/default-plugins/#talk-plugin-viewin Provides a sort for the comments with the most `like` reactions first. -### talk-plugin-love +## talk-plugin-love Source: [plugins/talk-plugin-love](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-love){:target="_blank"} Enables a `love` reaction button. -### talk-plugin-sort-most-loved +## talk-plugin-sort-most-loved Source: [plugins/talk-plugin-sort-most-loved](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-loved){:target="_blank"} @@ -39,7 +39,7 @@ Requires: [talk-plugin-viewing-options]({{ "/default-plugins/#talk-plugin-viewin Provides a sort for the comments with the most `love` reactions first. -### talk-plugin-remember-sort +## talk-plugin-remember-sort Source: [plugins/talk-plugin-remember-sort](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-remember-sort){:target="_blank"} @@ -47,7 +47,7 @@ Requires: [talk-plugin-viewing-options]({{ "/default-plugins/#talk-plugin-viewin Enables saving a user’s last sort selection as they browse other articles. -### talk-plugin-deep-reply-count +## talk-plugin-deep-reply-count Source: [plugins/talk-plugin-deep-reply-count](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-deep-reply-count){:target="_blank"} @@ -55,7 +55,7 @@ Enables counting of comments to include replies via a new graph edge. Not recommended for large installations as it will unreasonably reduce the query efficiency to compute this number. -### talk-plugin-slack-notifications +## talk-plugin-slack-notifications Source: [plugins/talk-plugin-slack-notifications](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-slack-notifications){:target="_blank"} @@ -70,12 +70,11 @@ Slack, if this isn't what you want, be sure to use the provided plugin as a recipe to further customize the behavior*. Configuration: -{:.no_toc} - `SLACK_WEBHOOK_URL` (**required**) - The webhook url that will be used to post new comments to. -### talk-plugin-toxic-comments +## talk-plugin-toxic-comments Source: [plugins/talk-plugin-toxic-comments](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-toxic-comments){:target="_blank"} @@ -85,7 +84,6 @@ threshold. For more information on what Toxic Comments are, check out the [Toxic Comments]({{ "/toxic-comments/" | relative_url }}) documentation. Configuration: -{:.no_toc} - `TALK_PERSPECTIVE_API_KEY` (**required**) - The API Key for Perspective. You can register and get your own key at [http://perspectiveapi.com/](http://perspectiveapi.com/){:target="_blank"}. @@ -97,7 +95,7 @@ Configuration: be processed before it will skip the toxicity analysis, parsed by [ms](https://www.npmjs.com/package/ms){:target="_blank"}. (Default `300ms`) -### talk-plugin-subscriber +## talk-plugin-subscriber Source: [plugins/talk-plugin-subscriber](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-subscriber){:target="_blank"} diff --git a/docs/_docs/03-04-plugin-recipes.md b/docs/_docs/04-04-plugin-recipes.md similarity index 95% rename from docs/_docs/03-04-plugin-recipes.md rename to docs/_docs/04-04-plugin-recipes.md index 6b76a54ca..019ff21e4 100644 --- a/docs/_docs/03-04-plugin-recipes.md +++ b/docs/_docs/04-04-plugin-recipes.md @@ -16,7 +16,7 @@ The following are the available recipes for use: {% include toc.html %} -### recipe-avatar +## recipe-avatar Source: [talk-recipes/tree/master/plugins/avatar](https://github.com/coralproject/talk-recipes/tree/master/plugins/avatar){:target="_blank"} @@ -24,7 +24,7 @@ Provides support for avatars hosted via third party, extends the User Model and provides UI on the client-side too. -### recipe-translations +## recipe-translations Source: [talk-recipes/tree/master/plugins/translations](https://github.com/coralproject/talk-recipes/tree/master/plugins/translations){:target="_blank"} @@ -32,7 +32,7 @@ Provides an example for overriding application text through the translation system. -### recipe-subscriber +## recipe-subscriber Source: [talk-recipes/tree/master/plugins/subscriber](https://github.com/coralproject/talk-recipes/tree/master/plugins/subscriber){:target="_blank"} @@ -41,7 +41,7 @@ Provides an example for adding `SUBSCRIBER` badges for users with the the auth system. -### recipe-author-name +## recipe-author-name Source: [talk-recipes/tree/master/plugins/author-name](https://github.com/coralproject/talk-recipes/tree/master/plugins/author-name){:target="_blank"} diff --git a/docs/_sass/talk.scss b/docs/_sass/talk.scss index 85e5f1c93..69e039951 100644 --- a/docs/_sass/talk.scss +++ b/docs/_sass/talk.scss @@ -41,9 +41,6 @@ h2, h3, h4 { } article.configuration { - h2 { - font-weight: bolder; - } h2, .toc { @extend .param;