This task is about implementing an invent that should log instances when people "open" the Reply Tool's advanced "shelf."
Background
T249391 implements functionality that enables people to customize the edit summary that accompanies the comments people post with the Reply Tool.
This task will help us understand the extent to which people are discovering this functionality.
This task is prompted, in part, by some volunteers expressing doubt that others would expect to find for the custom edit summary functionality within the "Advanced" link. [i]
Requirements
Event | Name |
---|---|
An event that fires when the Advanced link/affordance is clicked to "show" the Comment summary field | feature: dtReply, action: advanced-show |
An event that fires when the Advanced link/affordance is clicked to "hide" the Comment summary field | feature: dtReply, action: advanced-hide |
Open questions
- 1. What event(s) need to be created?
- An event that fires when the Advanced link/affordance is clicked to "show" the Comment summary field
- An event that fires when the Advanced link/affordance is clicked to "hide" the Comment summary field
- 2. What should these event(s) be called?
Event | Name |
---|---|
An event that fires when the Advanced link/affordance is clicked to "show" the Comment summary field | feature: dtReply, action: advanced-show |
An event that fires when the Advanced link/affordance is clicked to "hide" the Comment summary field | feature: dtReply, action: advanced-hide |
- 3. What schema should these event(s) be stored in?
- All events should be stored in VisualEditorFeatureUse as was done in T254291.
- 4. What – if any – editing interfaces, beyond the Reply Tool [and eventually, the New Discussion Tool] should Product Analytics and QA expect to see edit summary events emitted from?
- PA should not expect to see any other editing interfaces to emit an event that contains the following: dtReply and advanced-show or advanced-hide. See: T261816#6467771.
Done
- All "Open questions" are answered
- @DLynch: The changes described in the "Requirements" section above are implemented.
- @Ryasmeen: verify the events described in the "Requirements" section above are "firing" as described
- @MNeisler update Talk pages/Replying/Instrumentation spec with events added as part of this task.
- @MNeisler: document whether the events defined in the instrumentation spec [3] are landing the database in the ways we expect
- @MNeisler update Replying QC Template : Instrumentation QA and data checks
- @MNeisler update VisualEditorFeatureUse data dictionary with events added as part of this task. Note: This will be done after everything looks good on production.