-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Add matamo integration doc #723
base: main
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @farhaanbukhsh! This repository is currently maintained by @openedx/docs-openedx-org-maintainers. Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
2. Add the script provided by the platform to the file. | ||
3. Apply the theme, and we are good to go. | ||
|
||
Note:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note:: | |
.. note:: |
and the following line will need indentation. See https://docs.openedx.org/en/latest/documentors/references/quick_reference_rst.html#directives
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally looks good, but I would recommend a few changes.
- Don't focus this on Matamo, but use Matamo as an example. What I mean is, make this a generic document about how to integrate any analytics system with Open edX and then give Matamo as one such example.
- Give some actual example code. i.e. with a fake Matamo domain etc. so it's clearer what needs to be done.
Signed-off-by: Farhaan Bukhsh <[email protected]>
979a717
to
160e1aa
Compare
Addressed those comments @xitij2000 , Thank you for the review. |
@@ -0,0 +1,49 @@ | |||
Configuring Analytics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this title is misleading. When I saw it in the TOC, I thought it was about enabling Aspects and was confused why I couldn't find the doc on Matamo. The file name and the document title should match. So this should be called "Matamo Analytics", or it could be called "Configuring Site-wide Analytics Tools" and the doc title made to match.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree @sarina I was also a bit on the fence about the title so thanks a lot for your suggestion I have named is a site-wide analytics tool. This makes more sense.
Since it gives an idea that it is more than just Matamo.
|
||
Matamo needs to be included under the head tag of the page; hence, we will use head-extra.html to include the analytics script. | ||
|
||
1. Create the head-extra.html file under {theme}/lms/templates/. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use #.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
1. Create the head-extra.html file under {theme}/lms/templates/. | ||
2. Add the script provided by the platform to the file. | ||
|
||
For example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indent this example at the same level as the numbered bullet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll merge for you once @xitij2000 approves :) thanks for adding a doc!
Description
This PR aims to help add documentation regarding adding analytics to the platform apart from Google Analytics.
Useful information to include:
Supporting information
Testing instructions
Nothing to test
Deadline
"None"
Other information
Include anything else that will help reviewers and consumers understand the change.
Private ref: BB-9388