docs: Enable Google Analytics and implement a pop-up cookie consent banner#722
Merged
Conversation
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
|
I have reviewed the PR and also run it locally. All good! |
Collaborator
Author
|
Thanks, @geoffreynyaga and @lmlg! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR enables Google Analytics (GA) for MicroCeph documentation. But to use GA on a Read the Docs (RTD) project, it is required to implement a consent collection mechanism before placing tracking cookies on a reader's device. The standard way we collect user consent is by using the web team’s cookie policy banner, which is visually consistent across our Ubuntu and Canonical properties. This is now also available for RTD projects.
The PR adds:
header.htmlthat inserts the GA tracking tag onto each page, andfooter.htmlthat provides a link for users to change their data collection preferences. The files are available to download from the RTD-cookie-banner repository. The README file of the cookie banner repository contains the implementation instructions.When this PR is merged, the cookie banner will be shown to our users, and GA collection will begin as soon as a user accepts tracking cookies.
Type of change
How has this been tested?
Note
You may need to clear your browser cache for changes to take effect, or use Incognito mode.
Contributor checklist
Please check that you have: