diff --git a/docs/_config.yml b/docs/_config.yml index fea4db246..db86b4402 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -170,6 +170,12 @@ sidebar: url: /migration/4/ - title: Migrating to v4.1.0 url: /migration/4.1/ + - title: FAQ & Troubleshooting + children: + - title: FAQ + url: /faq/ + - title: Troubleshooting Tips + url: /troubleshooting-tips/ - title: Contact url: /contact/ diff --git a/docs/source/07-01-faq.md b/docs/source/07-01-faq.md index 06d0b0669..8f34adbf1 100644 --- a/docs/source/07-01-faq.md +++ b/docs/source/07-01-faq.md @@ -3,15 +3,67 @@ title: FAQ permalink: /faq/ --- -## How can I get help integrating Talk into my newsroom? +## How can I get help, submit a bug, or suggest a feature? -We're here to help with newsrooms of all sizes. Email our Integration Engineer -([jeff@mozillafoundation.org](mailto:jeff@mozillafoundation.org)) to set up a meeting. +There are a few avenues to get in touch with us and others in the community for help. -## How do I request a feature or submit a bug? +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. -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. +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. + +And you can also search our [Coral Community](https://community.coralproject.net) to see if your issue has been solved, or to get tips from the community. ## 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/master/CONTRIBUTING.md) to get started, but feel free to reach out to us via Github, or get in touch directly with Jeff via jeff@mozillafoundation.org. +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? + +Talk is open source, so you're free to develop additional functionality and [submit a pull request](https://github.com/coralproject.net/talk). + +## Do you have GDPR features? + +Yes! Please read our [GDPR documentation](/talk/integrating/gdpr/) for more information and instructions to get started. + +## Can I import my existing comments? + +Yes! We have a community-supported [import framework](https://github.com/coralproject/talk-importer) that you can use to migrate your existing comments. + +## What support is available? + +Our team is small, so it's difficult for us to provide support packages. However, you can always email us at [support@coralproject.net](mailto:support@coralproject.net), and we can help answer your questions. In some cases, we can provide premium support packages either with our team, or through partners. You can inquire about this via the support email address above. + +## Is there a hosted version I can purchase by monthly subscription? + +Yes! We are happy to announce that as of July 2018, we provide a SaaS version of Talk, called the Coral Cloud. For a monthly subscription, you get your own hosted Talk instance to embed on your news and blog articles. [Reach out to us](mailto:support@coralproject.net) if you're interested in this option. + +## Where is our data when we use Talk? + +If you are hosting Talk on your own: + +* Your data is stored in a MongoDB database that you provide +* The Coral Team doesn’t have any access to your data + +If you are using Coral Cloud Hosting for Talk: + +* Your data is stored in a dedicated MongDB database that is provisioned for your in the Cloud +* Your data is completely isolated from other customer’s data +* The Coral Team and its third party database hosting providers use strict access controls and auditing to protected your data from unauthorized access by team members + +## Does Talk have any automated moderation features to protect against spam and trolling? + +Talk features a couple of plugins that provide advanced moderation: + +* The [Toxic Comments plugin](/talk/plugin/talk-plugin-toxic-comments) integrates with the [Perspective API from Google](https://www.perspectiveapi.com/) to detect the likelihood of toxicity of comments in real-time +* The [Akismet plugin](/talk/plugin/talk-plugin-akismet) detects and blocks spam comments + +## How much can I customize Talk? + +* The CSS of the Talk comment stream can be customized by [adding your own CSS via an external stylesheet](/talk/integrating/styling-css/) +* The functionality of Talk can be [extended through the plugin framework](/talk/plugins/) + +## How much does Talk cost? + +* The Talk software is freely available under the Apache 2.0 open source license +* Associated costs are those for the infrastructure required to run Talk (i.e. cloud hosting fee or bare-metal server costs) +* The Coral Project offers a SaaS version of Talk. Please [get in touch with us](mailto:support@coralproject.net) to discuss pricing for your custom requirements. diff --git a/docs/source/07-02-troubleshooting-tips.md b/docs/source/07-02-troubleshooting-tips.md new file mode 100644 index 000000000..a63f2f13e --- /dev/null +++ b/docs/source/07-02-troubleshooting-tips.md @@ -0,0 +1,36 @@ +--- +title: Troubleshooting Tips +permalink: /troubleshooting-tips/ +--- + +## I've installed Talk but I can't see the comment stream appear on my articles + +* Make sure you've adding the correct domains to your Permitted Domains in Configure > Tech Settings +* Make sure you've correctly added the embed via your CMS to your article pages +* Check the console for any errors and you can file a bug via [support](mailto:support@coralproject.net) if you can't resolve the issue + +## My commenters are reporting they can't see the comment stream, but I'm able to + +* If this seems to be isolated to one commenter, it could be related to 3rd party cookies +* Post 4.x Talk doesn't require 3rd party cookies to be enabled. Check the version of Talk you're using and you might consider upgrading. +* A quick fix in the meantime is to ask them to allow 3rd party cookies +* You could also try asking them to clear their browser cache + + +## My commenters are reporting that they cannot login to Talk + +If you're using your own custom auth plugin: + +* Review the code and your server logs to ensure your plugin is working correctly. Check [our auth docs](/talk/integrating/authentication/) for more tips. +* Ensure that your JWT token settings, especially expiry, is being set correctly. You can troubleshoot JWT related issues with the [JWT Debugger](https://jwt.io/). +* See if you can isolate if it's a particular group of users that are experiencing this issue, e.g. mods, admins, subscribers? Confirm they have the appropriate permissions to comment. +* Note if this is a new issue that happened after an upgrade - did you read the [migration docs](/talk/migration/3/) and the [release notes](https://github.com/coralproject/talk/releases)? This might help you resolve the issue +* Confirm that users who are affected have the correct `username.status`. If users have status `UNSET`, this is related to a bug with upgrading from 3.x to 4.x that has affected some organizations. Read more here about [upgrading from 3.x to 4.x](/talk/migration/3/). +* If you're still experiencing issues, log a [support ticket](mailto:support@coralproject.net) so we can help diagnose the issue + + +If you're using `talk-plugin-auth`: + +* See if you can isolate if it's a particular group of users that are experiencing this issue, e.g. mods, admins, subscribers? Confirm they have the appropriate permissions to comment. +* Note if this is a new issue that happened after an upgrade - did you read the [migration docs](/talk/migration/3/) and the [release notes](https://github.com/coralproject/talk/releases)? This might help you resolve the issue. +* If you're still experiencing issues, log a [support ticket](mailto:support@coralproject.net) so we can help diagnose the issue diff --git a/docs/source/integrating/styling-css.md b/docs/source/integrating/styling-css.md index aad78d0b2..08bbc08bd 100644 --- a/docs/source/integrating/styling-css.md +++ b/docs/source/integrating/styling-css.md @@ -8,3 +8,300 @@ You can add your own stylesheet in Admin > Configure > Tech Settings. If you would like to change the styling of any elements in Talk, we provide global classnames with the prefix `talk-`. 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. Plugins also have their own stylesheets located in the client directory. + + +Here is an example stylesheet that we use on our [Coral Blog](https://coralproject.net/blog): + +```css +/* + * You can use this stylesheet as a place to get started + * for styling your own version of Talk! + * Author: Sam Hankins, Coral Project, 2018 + * License: Apache 2.0 + */ + +* { + /* font-family: inherit; */ +} + +html, body { + width:auto; + height:auto; +} + +body { + font-family: Helvetica, 'Helvetica Neue', Verdana, sans-serif; + width: 100%; + font-size: 14px; + margin: 0px; + padding: 0px 0px 100px 0px; + height: auto !important; +} + +#talk-embed-stream-container { + padding: 4px; +} + +.expandForSignin { + min-height: 600px; +} + +.coralButton { + margin: 5px 10px 5px 0px; + background: none; + padding: 0px; + border: none; + font-size: inherit; +} + +.coralButton:hover { + border-radius: 2px; + color: #767676; +} + +.coralButton i { + margin-right: 3px; +} + +.coralHr { + border: 0; + height: 0; + border-top: 1px solid rgba(0, 0, 0, 0.1); + border-bottom: 1px solid rgba(255, 255, 255, 0.3); +} + +.screen-reader-text { + clip: rect(1px, 1px, 1px, 1px); + height: 1px; + width: 1px; + overflow: hidden; + position: absolute !important; +} + +/* Notification styles */ +#coral-notif { + position: fixed; + border: 0; + background: rgb(105,105,105); + color: white; + border-radius: 2px; + font-weight: bold; +} + +/* Info Box Styles */ + + +.talk-plugin-infobox-info { + top: 0; + border: 0; + background: #DEEDFF; + color: #2a2a2a; + width: 100%; + text-align: left; + padding: 10px; + margin-bottom: 10px; + display: block; + box-sizing: border-box; + border-radius: 2px; +} + +.talk-plugin-infobox-info em{ + font-style: italic; +} + +.talk-plugin-infobox-info strong{ + font-weight: bold; +} + +.talk-plugin-infobox-info blockquote{ + border-left: solid 2px #2a2a2a; + padding-left: 10px; +} + + +.talk-plugin-infobox-info a{ + color: #2a2a2a; +} + +/* Question Box Styles */ + +.talk-stream-comments-container { + position: relative; +} + +/* Comment styles */ +.comment { + margin-bottom: 10px; + position: relative; +} + +.talk-plugin-commentcontent-text { + margin-bottom: 7px; + font-size: 16px; + font-weight: 100; + line-height: 1.3; +} + +/* Tag Labels */ + +.talk-plugin-tag-label { + background-color: #4C1066; + color: white; + display: inline-block; + border-radius: 2px; + font-size: 12px; + padding: 5px 6px; +} + +/* Comment Action Styles */ + +.commentActionsRight, .replyActionsRight { + display: flex; + justify-content: flex-end; +} +.commentActionsLeft, .replyActionsLeft { + display: flex; + justify-content: flex-start; + float: left; +} + +button.comment__action-button, +.comment__action-button button { + cursor: pointer; +} + +button.comment__action-button[disabled], +.comment__action-button[disabled] button { + cursor: inherit; +} + +.comment__action-button--nowrap { + white-space: nowrap; +} + +.likedButton { + color: rgb(0,134,227); +} + +.flaggedIcon { + color: #F00; +} + +/* Flag Styles */ + +.talk-plugin-flags-popup-form { + margin-bottom: 10px; +} + +.talk-plugin-flags-popup-header { + font-weight: bold; + font-size: 1rem; + margin-bottom: 10px; +} + +.talk-plugin-flags-popup-radio { + margin:5px; +} + +.talk-plugin-flags-popup-radio-label { + margin:5px; + font-weight: 400; + font-size: .9rem; +} + +.talk-plugin-flags-popup-counter { + float: left; + margin-top: 21px; + color: #999; +} + +.talk-plugin-flags-popup-button { + float: right; + margin-top: 10px; +} + +.talk-plugin-flags-reason-text { + margin-left: 20px; + margin-top: 5px; + width: 75%; + font-size: 16px; + border: 1px solid #ccc; + max-width: calc(100% - 40px); +} + +/* Close comments */ + +.close-comments-message { + box-sizing: border-box; + width: 100%; + height: 100px; +} + +.close-comments-confirm-wrapper { + float: right; +} + +.close-comments-alert { + background-color: #d65344; + color: white; + font-size: 1.33rem; + padding: 5px; +} + +.close-comments-alert i.material-icons { + font-size: 16px !important; +} + +/* Load More */ + +.talk-load-more { + text-align: center; +} + +.talk-load-more button { + width: 100%; + text-align: center; + color: #FFF; + background-color: #2376D8; + border-radius: 2px; + cursor: pointer; + padding: 10px; + border-radius: 2px; + line-height: 1em; + text-transform: capitalize; + display: inline-block; +} + +.talk-load-more:hover button { + background-color: #4399FF; +} + +.talk-new-comments { + width: 100%; + text-align: center; + margin: 4px 0; +} + +.talk-load-more-replies { + width: 100%; + padding-left: 20px; + box-sizing: border-box; +} + +.talk-load-more-replies .talk-load-more-button { + background-color: transparent; + color: #979797; + border: #979797 solid 1px; + border-radius: 2px; +} + +.talk-load-more-replies .talk-load-more:hover button { + background-color: #979797; + color: white; +} + +.hidden { + visibility: hidden; + display: none; +} +```