feedback.md

title	date	description	weight
Analytics, User Feedback, and SEO	2019-06-05	Add Google Analytics tracking to your site, collect user feedback and learn about the page description meta tag.	8

Adding Analytics

The Docsy theme builds upon Hugo's support for Google Analytics, which Hugo provides through internal templates. Once you set up analytics as described below, usage information for your site (such as page views) is sent to your Google Analytics account.

Prerequisites

You will need an analytics ID for your website before proceeding (technically it's called a measurement ID or property ID but we'll use the term "analytics ID" in this guide). If you don't have one, see the How to get started section of Introducing Google Analytics 4 (GA4).

{{% alert title="Tip" %}}

Your project's analytics ID is a string that starts with G- (a GA4 measurement ID) or UA- (a universal analytics property ID).

{{% /alert %}}

Setup

Enable Google Analytics by adding your project's analytics ID to the site configuration file. For details, see Configure Google Analytics.

By default, Docsy uses the gtag.js analytics library for both GA4 (which requires gtag.js) and Universal Analytics (UA) site tags. If you prefer using the older analytics.js library for your UA site tag, then set params.disableGtagForUniversalAnalytics to true in your project's configuration file.

{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params] disableGtagForUniversalAnalytics = true {{< /tab >}} {{< tab header="hugo.yaml" lang="yaml" >}} params: disableGtagForUniversalAnalytics: true {{< /tab >}} {{< tab header="hugo.json" lang="json" >}} { "params": { "disableGtagForUniversalAnalytics": true } } {{< /tab >}} {{< /tabpane >}}

{{% alert title="Deprecation note and warning" color="warning" %}}

While you can configure your project's analytics ID by setting either the top-level googleAnalytics config parameter or services.googleAnalytics.id, googleAnalytics was deprecated in Hugo 0.120.0 and will be removed in a future release.

Do not define both parameters, otherwise this can result in unexpected behavior. For details, see Is services.googleAnalytics.id an alias for googleAnalytics.

{{% /alert %}}

{{% alert title="Production-only feature!" color="primary" %}}

Analytics are enabled only for production builds (called "environments" in Hugo terminology). For information about Hugo environments and how to set them, see the following discussion.

{{% /alert %}}

User Feedback

By default Docsy puts a "was this page helpful?" feedback widget at the bottom of every documentation page, as shown in Figure 1.

Figure 1. The feedback widget, outlined in red

After clicking Yes the user should see a response like Figure 2. You can configure the response text in your project's configuration file.

Figure 2. An example Yes response

How is this data useful?

When you have a lot of documentation, and not enough time to update it all, you can use the "was this page helpful?" feedback data to help you decide which pages to prioritize. In general, start with the pages with a lot of pageviews and low ratings. "Low ratings" in this context means the pages where users are clicking No --- the page wasn't helpful --- more often than Yes --- the page was helpful. You can also study your highly-rated pages to develop hypotheses around why your users find them helpful.

In general, you can develop more certainty around what patterns your users find helpful or unhelpful if you introduce isolated changes in your documentation whenever possible. For example, suppose that you find a tutorial that no longer matches the product. You update the instructions, check back in a month, and the score has improved. You now have a correlation between up-to-date instructions and higher ratings. Or, suppose you study your highly-rated pages and discover that they all start with code samples. You find 10 other pages with their code samples at the bottom, move the samples to the top, and discover that each page's score has improved. Since this was the only change you introduced on each page, it's more reasonable to believe that your users find code samples at the top of pages helpful. The scientific method, applied to technical writing, in other words!

Setup

{{% alert title="Version note" color=warning %}}

As of Docsy version 0.8.0, feedback will be enabled whether site.Config.Services.GoogleAnalytics.ID is set or not. This supports the use case where analytics is configured outside of Docsy.

{{% /alert %}}

1. Open your project's Hugo configuration file.

2. Set the response text that users see after clicking Yes or No.

   {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}}

{{< tab header="hugo.toml" lang="toml" >}} [params.ui.feedback] enable = true yes = 'Glad to hear it! Please tell us how we can improve.' no = 'Sorry to hear that. Please tell us how we can improve.' {{< /tab >}} {{< tab header="hugo.yaml" lang="yaml" >}} params: ui: feedback: enable: true 'yes': >- Glad to hear it! Please tell us how we can improve. 'no': >- Sorry to hear that. Please tell us how we can improve.

{{< /tab >}}{{< tab header="hugo.json" lang="json" >}}

{ "params": { "ui": { "feedback": { "enable": true, "yes": "Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new\"> tell us how we can improve.", "no": "Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new\"> tell us how we can improve." } } } }

{{< /tab >}} {{< /tabpane >}}

3. Save the edits to your configuration file.

By default, Docsy emits an event value of 100 when a user clicks "yes". You can change this value by setting params.ui.feedback.max_value to a positive integer. Docsy uses 0 for "no" events.

Access the feedback data

Page feedback is reported to Google Analytics through events.

{{% alert title="Version note" color=warning %}}

As of Docsy version 0.8.0, page feedback is reported as custom page_helpful events, rather than click events.

{{% /alert %}}

This section assumes basic familiarity with Google Analytics. For example, you should know how to check pageviews over a certain time range and navigate between accounts if you have access to multiple documentation sites.

1. Open Google Analytics.
2. Open Reports > Engagement > Events.
3. Click page_helpful in the events table. If there is no page_helpful event, then none have been registered for the selected period. Adjust the period as necessary.

Note that you might be required to create a custom report if you'd like better visualize individual data points (per page) along with average values.

Disable feedback on a single page

Add the parameter hide_feedback to the page's front matter and set it to true.

{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ hide_feedback = true +++ {{< /tab >}} {{< tab header="yaml" lang="yaml" >}}

hide_feedback: true

{{< /tab >}} {{< tab header="json" lang="json" >}} { "hide_feedback": true } {{< /tab >}} {{< /tabpane >}}

Disable feedback on all pages

Set params.ui.feedback.enable to false in hugo.toml/hugo.yaml/hugo.json:

{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.ui.feedback] enable = false {{< /tab >}} {{< tab header="hugo.yaml" lang="yaml" >}} params: ui: feedback: enable: false {{< /tab >}} {{< tab header="hugo.json" lang="json" >}} { "params": { "ui": { "feedback": { "enable": false } } } } {{< /tab >}} {{< /tabpane >}}

Add a contact form with Fabform

You can create a contact form for your site and collect your form submissions at fabform.io. To use this feature, you first need to sign up for an account with Fabform. The following example shows how to add a simple form that collects the user's email address to your site source:

<form action="https://fabform.io/f/{form-id}" method="post">
 <label for="email">Your Email</label>
 <input name="email" type="email">
 <button type="submit">Submit</button>
</form>

For more details, see Add a Hugo contact form in the Fabform documentation.

Search Engine Optimization meta tags

To learn how to optimize your site for SEO see, Search Engine Optimization (SEO) Starter Guide.

Google recommends using the description meta tag to tell search engines what your page is about. For each generated page, Docsy will set the content of the meta description by using the first of the following that is defined:

• The page description [frontmatter field]({{< ref "content#page-frontmatter" >}})
• For non-index pages, the page summary, as computed by Hugo
• The site description taken from the site params

For the template code used to perform this computation, see layouts/partials/page-description.html.

Add more meta tags as needed to your project's copy of the head-end.html partial. For details, see [Customizing templates]({{< ref "lookandfeel#customizing-templates"

}}).