Use Matomo for page feedback mechanism #581
Merged
Conversation
This file contains 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
Signed-off-by: Ross Turk <ross@rossturk.com>
Signed-off-by: Ross Turk <ross@rossturk.com>
Signed-off-by: Ross Turk <ross@rossturk.com>
Signed-off-by: Ross Turk <ross@rossturk.com>
Signed-off-by: Ross Turk <ross@rossturk.com>
Signed-off-by: Ross Turk <ross@rossturk.com>
kaxil
approved these changes
Apr 26, 2022
|
I just uploaded the PyPI package and restarted the doc build in ~ 20 minutes the latest changes should be live at our page - so worth checking it :) |
|
@potiuk It looks correct to me 👍 |
|
Cool! thanks! |
potiuk
pushed a commit
that referenced
this pull request
Jun 17, 2023
* Disable GA-based feedback mechanism in Docsy * Move to Matomo for page feedback mechanism * Update feedback mechanism to Matomo in archived docs * Bump sphinx doc theme * Switch order of category and action Signed-off-by: Ross Turk <ross@rossturk.com>
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.
I was made aware that the page feedback mechanism (i.e., "do you find this page helpful?") in each docs page also uses Google Analytics. As a followup to #576, this moves the mechanism over to Matomo.
Each time a user clicks on the rating button, it will send an event to Matomo. Events in Matomo have a
categoryand anaction, along with an optionalnameandvalue. I have chosen Docs for the category and Rating as the action - the name is set to the current page path and the value is the numerical rating.This required a lot of individual file changes in
docs-archive. Sorry about the big PR, again! I think it's safe to ignore commit e933c52 :)Unfortunately, I haven't yet been able to cleanly fix the feedback mechanism for the landing pages. The feature is currently implemented in Docsy, and somewhat tied to GA. For now it has been disabled in this PR.
(This also, as a side effect, more completely deploys the fix in #534. While comparing all of the various
docs.jsfiles in the docs archive, I found that they were all the same except for some where that fix had not yet been applied.)Finally, this bumps the version of the Sphinx theme, so that future doc builds will include the updated mechanism. I'm not sure if the PyPI publication is automatic or not :)