google / google/site-kit-wp

Add GA event tracking for the RRM express setup flow

Open
#13,573 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Module: RRM P0 Team M Type: Enhancement
Dominant language
JavaScript
Stars
1.4k
Forks
384
Avg merge
4d 14h
Merged PRs (30d)
77

Description

Feature Description

GA event tracking should be added to the RRM express setup flow itself, covering both the flow as a whole and the steps within it:

  • Starting, completing and exiting the flow.
  • Starting and completing each step.
  • The "Learn more" link within a step.
  • The "Create new publication" and "Use existing publication" links that switch between the two publication setup paths.

The create and connect paths should be distinguished in the events. create-publication is not a routing step, so it is composed as the event label when the user is on the create path.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

The following GA events should be tracked for the RRM express setup flow. All share the category {viewContext}_rrm-express-setup_{ctaSlug}, where {ctaSlug} is the CTA being set up. See the GA events sheet.

Event name Label Trigger Condition
start_setup element visibility The user starts the RRM express setup.
complete_setup element visibility The user reaches the setup complete step.
exit_setup current step click The user clicks "Exit setup".
start_step current step element visibility The user starts a step.
complete_step current step click The user completes a step.
click_learn_more_link current step click The user clicks the "Learn more" link in a step.
click_create_new_publication_link connect-publication click The user clicks "Create new publication" in the publication setup step.
click_use_existing_publication_link create-publication click The user clicks "Use existing publication" in the publication setup step.
  • The label is the step slug, with the exception of create-publication, which is not a step of its own and is reported by the publication setup step while the create form is shown.
  • complete_step for the setup-complete step is tracked when the user clicks "Return to Dashboard", the step's forward action.
  • click_learn_more_link is tracked in each step that offers a "Learn more" link.
  • The events above are tracked only with the rrmExpressSetup feature flag enabled.

Implementation Brief

Test Coverage

QA Brief

Changelog entry

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named. Start by locating the RRM express setup flow and existing GA event tracking, then map the acceptance-criteria table to each flow, step, link, and publication path; done means all listed events use the required category and labels only when the rrmExpressSetup feature flag is enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
analytics, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.