Page MenuHomePhabricator

Log template metadata whenever a template dialog is opened
Closed, ResolvedPublic2 Estimated Story Points

Description

Record information about the template upon opening a template dialog in VisualEditor or TemplateWizard. This will be summarized to learn about the actual, human usage frequency of templates.

Data to record:

  • Template title
  • Whether this is adding or editing an invocation
  • Whether TemplateData was found

We probably need to add a new event type, since there's no way to pass data through VisualEditorFeatureUse.

Event Timeline

awight renamed this task from Log template title whenever a template dialog is opened to Log template metadata whenever a template dialog is opened.Aug 5 2020, 1:04 PM
awight updated the task description. (Show Details)

Nice! I added the parent task, which should maybe be edited since I think now these overlap a bit.

Lena_WMDE set the point value for this task to 3.Sep 3 2020, 9:23 AM

which should maybe be edited since I think now these overlap a bit.

Discussed in story time and decided the overlap is fine, since the open vs. edit will be tied to the actual template names here. Will leave the ticket as is.

We also discussed that it's worth collecting for both VE and TemplateWizard.

Change 643715 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/TemplateWizard@master] [WIP] Track usage of template data on insertion

https://gerrit.wikimedia.org/r/643715

@ECohen_WMDE @Lena_WMDE I ran into the following questions regarding the tracking.

I could either

  • track the metadata only whenever a template is saved ( or saved after it was edited ) so the workflow is finished
  • track the metadata whenever a template was opened in the dialogue after a search ( or for editing )

Also note, that the MediaWiki-extensions-TemplateWizard does not allow editing of inserted templates using it's dialogue. So we will have no data there.

Thanks for asking @WMDE-Fisch. Elisha and I discussed it and think the second option would be most useful:

track the metadata whenever a template was opened in the dialogue after a search ( or for editing )

This will allow us to see which templates editors attempt to use/find most often and also compare to TemplateWizard.

ppelberg moved this task from To Triage to Triaged on the VisualEditor board.
ppelberg moved this task from Backlog to External on the Editing-team (Tracking) board.
ppelberg added a subscriber: ppelberg.

So it seems adding the tracking to the VE part is a bit hard/very annoying. So while wrapping my head around this I thought about what we actually want to find out here. And if the information gathered needs to be combined in the way I just imagined when approaching the task.

For the non-VE part I track an event in the moment where a template got loaded into the interface and with that event I also track the name and the fact if it has template data. I do the same when the template is actually used.

For VE it would be easy to track when a template is loaded into the interface ( and also if it's an addition or an edit ) but adding an information piece if it uses template data in combination with the load event is tricky.

So I wonder if the information if a certain template has template data even needs to be combined with these load and edit events. Or if rather on the one hand want to get a general feeling on how many templates used have template data and on the other hand want to see how often templates are added or edited in general.

Both could be tracked separately in completely different places and since they could be connected via the template's name we could then also e.g. find templates that are very often used but lack template data. ( if that's what we want to know )

@Lena_WMDE @ECohen_WMDE

Change 643715 merged by jenkins-bot:
[mediawiki/extensions/TemplateWizard@master] Track usage of template data on load and insertion

https://gerrit.wikimedia.org/r/643715

Thanks @WMDE-Fisch ! As discussed it would be fine to track these two things in different places.

Change 648251 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/VisualEditor@master] [WIP] Add tracking of template usage

https://gerrit.wikimedia.org/r/648251

Change 649411 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/TemplateData@master] [WIP] Add tracking to get template data presense

https://gerrit.wikimedia.org/r/649411

Lena_WMDE changed the point value for this task from 3 to 2.

Change 648251 merged by jenkins-bot:
[mediawiki/extensions/VisualEditor@master] Add tracking of template usage

https://gerrit.wikimedia.org/r/648251

Change 649411 merged by jenkins-bot:
[mediawiki/extensions/TemplateData@master] Add tracking for template data presence

https://gerrit.wikimedia.org/r/649411