Skip to content

Commit

Permalink
Page feedback & GA4 docs adjustments (#1742)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Nov 17, 2023
1 parent 2f71d33 commit 89dd0e2
Showing 1 changed file with 20 additions and 30 deletions.
50 changes: 20 additions & 30 deletions userguide/content/en/docs/adding-content/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,41 +191,31 @@ 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.

[0.8.0]: https://github.com/google/docsy/blob/main/CHANGELOG.md/#080

{{% /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 **Behavior** > **Events** > **Overview**.
3. In the **Event Category** table click the **Helpful** row. Click **view full
report** if you don't see the **Helpful** row.
4. Click **Event Label**. You now have a page-by-page breakdown of ratings.

Here's what the 4 columns represent:

- **Total Events** is the total number of times that users clicked _either_
**Yes** or **No**.
- **Unique Events** provides a rough indication of how frequently users are
rating your pages per session. For example, suppose your **Total Events** is
5000, and **Unique Events** is 2500. This means that you have 2500 users who
are rating 2 pages per session.
- **Event Value** isn't that useful.
- **Avg. Value** is the aggregated rating for that page. The value is always
between 0 and 1. When users click **No** a value of 0 is sent to Google
Analytics. When users click **Yes** a value of 1 is sent. You can think of it
as a percentage. If a page has an **Avg. Value** of 0.67, it means that 67% of
users clicked **Yes** and 33% clicked **No**.

[events]:
https://developers.google.com/analytics/devguides/collection/analyticsjs/events
[pr]: https://github.com/google/docsy/pull/1/files

The underlying Google Analytics infrastructure that stores the "was this page
helpful?" data is called [Events][events]. See [docsy pull request #1][pr] to
see exactly what happens when a user clicks **Yes** or **No**. It's just a
`click` event listener that fires the Google Analytics JavaScript function for
logging an Event, disables the **Yes** and **No** buttons, and shows the
response text.
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.

[events]: https://support.google.com/analytics/answer/9322688

### Disable feedback on a single page

Expand Down

0 comments on commit 89dd0e2

Please sign in to comment.