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.

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

docs: add Matomo tracking to docs #20398

Conversation

codyml
Copy link
Member

@codyml codyml commented Jun 15, 2022

SUMMARY

  • Run Prettier on docusaurus.config.js
  • Put Matomo tracking script in JS file and inject in <head> of each page using scripts key in docusaurus.config.js

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Script in <head>:
Screen Shot 2022-06-15 at 11 31 14 AM

Ping sent:
Screen Shot 2022-06-15 at 11 31 22 AM

TESTING INSTRUCTIONS

  1. Run docs:
cd docs
yarn install
yarn start
  1. Visit http://localhost:3000 and check for <script src="/script/matomo.js"></script> in the <head> tag of the homepage and various other pages. You can also check that the tracker's ping was sent to analytics.apache.org.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

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

LGTM - though it might be worth, as a follow-up, adding some comments at the top of the matomo.js script attributing that code to Matomo, since it may not in fact be under the apache license (required by our CI)

@rusackas rusackas merged commit 467d8ef into apache:master Jun 16, 2022
akshatsri pushed a commit to charan1314/superset that referenced this pull request Jul 19, 2022
* Apply Prettier formatting.

* Add Matomo script to Docusaurus config.

* Add Apache license to Matomo script.
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.1.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 2.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants