This task involves the work of adding a new event to track when people click on the edit affordances ([[ ]], ✏️, and Add topic (T304187)) being introduced within the site-wide sticky header.
Requirements
- The necessary event(s) are added to EditAttemptStep that enables us to track:
- Edit sessions initiated via clicks on the edit affordances present within the site-wide sticky header
- The editing interface people used the edit affordance within the site-wide sticky header to open
NOTE: As @MNeisler noted offline, the requirements above will likely require one new event [rather than three] considering we will be able to know the editing interface people are using a particular edit affordance within the sticky header to open by way of EditAttemptStep's existing editor_interface and integration fields.
Implementation Details
| Scenario | Data to be logged in EditAttemptStep |
|---|---|
| When someone opens the WikiEditor by clicking the [[ ]] button within the site-wide sticky header | action = init, integration = page, init_type = page, init_mechanism = 'click-sticky-header', editor_interface = wikitext. See: T309364. |
| When someone opens the visual editor by clicking the ✏️ button within the site-wide sticky header | action = init, integration = page, init_type = page, init_mechanism = 'click-sticky-header', editor_interface = visualeditor |
| When someone opens the New Topic Tool by clicking the Add topic button within the site-wide sticky header | action = init, integration = discussiontools, init_type = section, init_mechanism = 'click-sticky-header' |
| When someone opens the legacy new topic workflow by clicking the Add topic button in the site-wide sticky header | action = init, integration = page, init_type = section, init_mechanism = 'click-sticky-header' |
Note: the details above are borrowed from T298634#7855485.
Background
As part of rolling out the sticky header feature with edit buttons, we want to make sure that edit button clicks are captured in the EditAttemptStep schema (see T298518).
Minimal test case
Acceptance criteria
- Once edit buttons are included in the sticky header, edit clicks are logged in EditAttemptStep in a way that meets the ===Requirements above
- Editing QA verifies the new event(s) added as part of this task are being emitted as expected by clients
- @MNeisler to verify that aggregate data is logging to EditAttemptStep in the ways we expect it to
