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

chore(analytics): add Scarf to npm install, docs, and ui #725

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

Conversation

aviaviavi
Copy link

As discussed with @JamieSlome directly, this PR adds basic usage tracking tooling with Scarf, compliant with CNCF guidelines.

There are a few code-level modifications in this PR:

  • Basic metrics for npm installs
  • Adding a Scarf pixel to the documentation
  • Adding a Scarf pixel to the footer of the UI, for basic metrics of when the UI is loaded for the first time.

As with all Scarf-based tracking, these metrics are fully anonymized and GDPR-compliant. No PII is being retained or exposed from this change.

I have the organization for git-proxy set up in Scarf, @JamieSlome as soon as you make an account I can transfer org ownership to you, and you'll be able to add any and all project maintainers.

Copy link

linux-foundation-easycla bot commented Oct 1, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for endearing-brigadeiros-63f9d0 ready!

Name Link
🔨 Latest commit 23e7de5
🔍 Latest deploy log https://app.netlify.com/sites/endearing-brigadeiros-63f9d0/deploys/671d3098940a6c0008f1e26f
😎 Deploy Preview https://deploy-preview-725--endearing-brigadeiros-63f9d0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JamieSlome
Copy link
Member

@aviaviavi - thanks for the PR ❤️

Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.34%. Comparing base (c84c100) to head (f0454f5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #725   +/-   ##
=======================================
  Coverage   57.34%   57.34%           
=======================================
  Files          46       46           
  Lines        1594     1594           
=======================================
  Hits          914      914           
  Misses        680      680           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JamieSlome
Copy link
Member

@aviaviavi - are you able to resolve the merge conflict? Apologies!

@JamieSlome JamieSlome removed the request for review from coopernetes October 2, 2024 15:09
@JamieSlome
Copy link
Member

@maoo - would be keen to get your thoughts here before we merge 👍

@aviaviavi
Copy link
Author

conflicts resolved!

@aviaviavi
Copy link
Author

@JamieSlome let me know if I can answer any questions here!

@eddie-knight
Copy link
Contributor

Hey @aviaviavi, could you email me any relevant documentation or agreements regarding how the data gathered by Scarf will be handled? I'll bring that to the TOC to propose approval for FINOS project adoption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants