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

MPP-3528: Recreate website metrics, add images #4793

Merged
merged 11 commits into from
Jun 26, 2024
Merged

Conversation

jwhitlock
Copy link
Member

@jwhitlock jwhitlock commented Jun 17, 2024

This rewrites METRICS.md to include all the frontend code that emits Google Analytics events, as well as sample images to make it easier to refer to buttons and text.

The images are minimized for size with pngquant. They are displayed at 1/3 width, and can be clicked to see the full image.

How to test:

  • Read the doc, see if anything sounds off. Don't feel you have to read all the details, skimming is fine.
  • Spot check by searching for categories, labels, etc in frontend/src.
  • I've added or updated relevant docs in the docs/ directory.

@jwhitlock jwhitlock marked this pull request as draft June 17, 2024 21:59
This rewrites METRICS.md to include all the frontend code that emits
Google Analytics events, as well as sample images to make it easier to
refer to buttons and text.

The images are minimized for size with pngquant.
@jwhitlock jwhitlock force-pushed the update-metrics-mpp-3528 branch from b11812a to c796010 Compare June 25, 2024 19:18
@jwhitlock jwhitlock marked this pull request as ready for review June 25, 2024 21:49
@jwhitlock jwhitlock requested a review from groovecoder June 25, 2024 21:49
Copy link
Member

@groovecoder groovecoder left a comment

Choose a reason for hiding this comment

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

Thanks! This is a great thorough update to the metrics doc.

The screenshots help establish context for the pings really well, but a couple (non-blocking) concerns about including screenshots:

  • We only include screenshots for the website and not the add-on
  • We will have to maintain the screenshots

clicked. This allows measuring the percentage of users that click a link, and the
effectiveness of different text and presentations.

Here is a summary of the event categories and actions:
Copy link
Member

Choose a reason for hiding this comment

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

suggestion (non-blocking):

Suggested change
Here is a summary of the event categories and actions:
Here is an in-depth table of the event categories and actions:

😛

@jwhitlock
Copy link
Member Author

The screenshots help establish context for the pings really well, but a couple (non-blocking) concerns about including screenshots:

We only include screenshots for the website and not the add-on

Yep, the new detailed sections only cover the website. The add-on documentation (called an "Extension", we should revisit if we want to use that) is untouched and at the bottom of the document. I hope to tackle that next.

We will have to maintain the screenshots

A few thoughts:

  1. We weren't doing a great job of updating this document when it was text only either, so yeah, it will get out of date.
  2. We have no dedicated design resources, so the design won't change
  3. It was easier to generate screenshots than to understand React code

@jwhitlock jwhitlock added this pull request to the merge queue Jun 26, 2024
Merged via the queue into main with commit ab8e6cc Jun 26, 2024
29 checks passed
@jwhitlock jwhitlock deleted the update-metrics-mpp-3528 branch June 26, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants