ClickHelp Documentation

Enable Commenting

Comments are a great way to allow readers to leave feedback and have discussion in your documentation. In ClickHelp, this is possible by enabling the Disqus comment hosting service for your documentation portal. This will also allow your team to exchange internal comments in a Restricted publication before going live with the final version of your content.

Signing up with Disqus

You will need to have an account in the Disqus service. Let's see how you can create one:

  1. Open the Disqus main page and click Get Started.
  2.  Fill in the registration form or sgn up via one of the social media accounts. Do not forget to check your inbox to verify the account.

Setting up Disqus

  1. Right after signing up you will be presented with two options. Choose the second - "I want to install Disqus on my site".

  2. Fill out the "Website Name" field. This is your Disqus identifier and is not connected to your ClickHelp Portal.
    Information Note that your disqus shortname may differ from the website name, as it has to be unique in the Disqus system.
  3.  Click the "Customize Your URL" link and customize your shortname if needed. Copy it to the clipboard - you will need to use it in ClickHelp. 

  4. Select Category that best suits you.
  5. After, you will need to choose Disqus pricing plan. You can go with Basic - simply click "Subscribe now".
  6. On the next step, scroll the grid of platforms down and click he "I don't see my platform listed, install manually with" button. 
  7. Then you can skip step #2 and choose "Configure Disqus" from the left menu. Click "Complete Setup" button and then the "Dismiss Setup" button.

Setting up ClickHelp

  1. Log in to your ClickHelp documentation portal.
  2. Navigate to Tools > Portal Settings... in the main menu.
  3. Navigate to the Reader Feedback section from the left-hand menu.
  4. Check the "Enable Disqus Comments" checkbox and insert your Disqus shortname (not the website name!):
  5. Save the changes.

Now, if you open any Publication, at the bottom of a topic you'll see the Disqus section. 

In the example above, we enabled Disqus globally, for all Publications. It is also possible to enable it for specific Publication only in their settings.

And don't forget that you can enable the topic feedback widget. Just check the relevant checkbox in the same section and save changes.

To learn more, refer to this topic: The 'Was it Helpful?' Widget.