Beta Release: Wikistats: support annotations in graphs
Open, HighPublic


As per Jon's suggestion and the capabilities of original wikistats/limn/dashiki.

A graph should display vertical bars that note major events we know about

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 11 2017, 10:52 PM
Tbayer added a subscriber: Tbayer.Oct 11 2017, 10:58 PM
Nuria renamed this task from Wikistats: support annotations to Beta Release: Wikistats: support annotations.Oct 11 2017, 11:12 PM
Nuria added a subscriber: Nuria.

Annotation functionality for graphs can be ported from dashiki

Ottomata moved this task from Incoming to Backlog (Later) on the Analytics board.Oct 12 2017, 4:08 PM
fdans edited projects, added Analytics-Kanban; removed Analytics.Jan 8 2018, 4:57 PM
Nuria renamed this task from Beta Release: Wikistats: support annotations to Beta Release: Wikistats: support annotations in graphs.Mar 22 2018, 6:49 PM
Nuria updated the task description. (Show Details)
mforns edited projects, added Analytics; removed Analytics-Kanban.May 7 2018, 4:13 PM
mforns moved this task from Backlog (Later) to Wikistats Beta on the Analytics board.
mforns triaged this task as Unbreak Now! priority.
Restricted Application added subscribers: Liuxinyu970226, TerraCodes. · View Herald TranscriptMay 7 2018, 4:13 PM
mforns lowered the priority of this task from Unbreak Now! to Needs Triage.May 7 2018, 4:13 PM
Milimetric triaged this task as Normal priority.May 7 2018, 8:07 PM
Milimetric raised the priority of this task from Normal to High.
mforns added a subscriber: mforns.May 14 2018, 5:02 PM

As discussed in the tasking meeting, one idea could be having a set of pages on-wiki under a json namespace that store the annotations.
Those would be divided in 3 levels:

Level 1 (one page):                                                re. all metrics

Level 2 (3 pages):           re. contributing metrics            re. reading metrics              re. content metrics

Level 3 (N pages):  re. metric 1       re. metric 2       re. metric 3      ....................................                re. metric N
  • The annotations stored in the "all metrics" file of level 1, would be shown for all metrics.
  • The annotations in a level-2 page, would be shown only for the metrics corresponding to that category: contributing, reading, content.
  • The annotations in a level-3 page, would only be shown for the metric in question.

The level-3 pages could be named after the corresponding metric (using a given convention), so that Wikistats knows how to access them, without keeping config?

Question remains, whether the annotation pages themselves should keep track of the 3 level structure by i.e. a link to the parent (and let mediawiki-storage handle indirections), or have Wikistats itself know the 3 level structure and request for each metric: the metric annotation page, the category annotation page, and the top "all metrics" page and merge them together.

As discussed in tasking, I'm breaking down this task into:

  • model an annotations schema that makes it easy for the UI to render
  • find or implement a way to visualize annotations in d3 line, bar, table, and map charts
  • program an API that reads current Dashiki-style annotations from and transforms them to the wikistats format. Keep it generic so we can switch out the storage later
  • link back to the annotation wiki pages from the metrics that render them
  • organize meta pages and documentation so that community members can intuitively understand what they're used for (add some descriptive metadata to the schema)
  • (low) improve the Dashiki mediawiki extension to render annotations in a friendlier layout
  • (lowest) add a way to select a time period on wikistats and add an annotation
  • (lowest) add a way to pop up a form on meta to add an annotation by editing the underlying json