Schema talk:HelpPanel

Maintainer:	Stephane Bisson
Team:	Growth
Project:	mw:Growth/Focus_on_help_desk
Status:	active
Purge:	After 90 days, auto-purge PII contained in event capsule, as well as User ID, Page ID, keep the rest indefinitely

This page holds a JSON schema that specifies a data model for EventLogging.

Logging and client-side validation error rate on Grafana

Server-side validation errors in Logstash

This schema is used to log user interactions with the Help Panel. For more information, see T206711 in Phabricator.

QA testing notes

In your browser console, use mw.trackSubscribe( 'event.HelpPanel', console.log ); or mw.loader.using( 'mediawiki.api' ).then( function () { new mw.Api().saveOption( 'eventlogging-display-web', '1' ); } );

If verifying flow of events in beta labs or in production, make sure your browser is not emitting Do-Not-Track header and make sure your adblocker has whitelisted the domain you are testing.

Scenarios

• All scenarios should be tested in desktop and mobile.
• Tests should be done with wikitext2017 editor off, since that is not default in most wikis.
• After going to production, all scenarios should be tested in a production non-English wiki.
• Page titles may vary depending on language.
• Default editor (visualeditor / wikitext) may vary depending on wiki.
• In each scenario, the events listed in italics are the only events that should be seen. Any missing events or additional events are bugs.

1. Scenario 1
   • Visit Special:Homepage.
   • Click "Ask help desk". (action = "review", editor_interface = "homepage", page_id = 0, page_title = "Special:Homepage", page_ns = -1)
2. Scenario 2
   • If your user page does not exist, visit your user page, causing the editor to open. (action = "impression", editor_interface = "visualeditor", page_id = 0, page_title = "User:[USERNAME]", page_ns = 2)
3. Scenario 3
   • If your user page does exist, visit your user page. (action = "impression", editor_interface = "reading", page_id = 0, page_title = "", page_ns = 2)
   • Click "Edit". (action = "impression", editor_interface = "visualeditor", page_id = [some number], page_title = "User:[USERNAME]", page_ns = 2)
4. Scenario 4
   • Visit the help desk. (action = "impression", editor_interface = "reading", page_id = 0, page_title = "", page_ns = 4)
   • Open the help panel. (action = "open", editor_interface = "reading", page_id = 0, page_title = "", page_ns = 4)
   • Click Edit. (action = "impression", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Open the help panel. (action = "impression", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Type in the question box. (action = "enter-question-text", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Click Continue. (action = "review", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Click "Post my question". (action = "submit-attempt", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4) AND (action = "submit-success", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Click Done. (action = "close", editor_interface = "visualeditor", page_id = [some number], page_title = "Wikipedia:Help_desk", page_ns = 4)
   • Click Read. (action = "impression", editor_interface = "reading", page_id = 0, page_title = "", page_ns = 4)
5. Scenario 5
   • Click "Random article".
   • Click Edit. (action = "impression", editor_interface = "visualeditor", page_id = [some number], page_title = "[some title]", page_ns = 0)
   • Switch to wikitext editor. (action = "impression", editor_interface = "wikitext", page_id = [some number], page_title = "[some title]", page_ns = 0)