Skip to content
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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: Add matamo integration doc #723

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb81cce
chore: Add matamo integration doc
farhaanbukhsh Jan 3, 2025
f507ce1
fixup! chore: Add matamo integration doc
farhaanbukhsh Jan 3, 2025
2c8aa46
fixup! chore: Add matamo integration doc
farhaanbukhsh Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions source/site_ops/how-tos/matamo-analytics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Configuring Matamo Analytics
#############################

In addition to Google Analytics, the Open edX platform is flexible enough to support different analytics tools.

To inject various analytics, there is a provision to add them to the head or body using head-extra.html, body-initial.html, or body-extra.html.

One needs to be using the comprehensive theme to use these templates. More information can be found in the `README.rst under themes in edx-platform <https://github.com/openedx/edx-platform/blob/master/themes/README.rst>`_.

Let us walk you through integrating Matamo into the platform:

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/.
2. Add the script provided by the platform to the file.
3. Apply the theme, and we are good to go.

Note::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note::
.. note::

and the following line will need indentation. See https://docs.openedx.org/en/latest/documentors/references/quick_reference_rst.html#directives


This will only be applied to the pages served by LMS and would not be supported by different MFEs used by the platform. Hence, to introduce the same, you need to create a custom component and put it in a slot. You can have a look at the `frontend-footer-component <https://github.com/openedx/frontend-component-footer>`_.