Page MenuHomePhabricator

Build a documentation metrics dashboard
Closed, ResolvedPublic

Description

This is a high-level task to group all work related to the documentation metrics dashboard.

Summary

Documentation metrics dashboard is a web application used to obtain information about collections of technical documentation pages. It's developed and maintained by the Wikimedia Technical Documentation Team.

The application is available at https://techdoc-dashboard.toolforge.org, with the source code on Wikimedia GitLab.

Version 1.0.0 is now live and features:

  • Collection dashboards which display information about page views, edits, editors, usage of translate syntax, and selected templates.
  • Dashboards for individual pages within a collection, with the same data.

With the release of version 1.0.0, this project is now complete. Further development is tracked in T356976 but that task is stalled as we focus on other work. Feedback, feature requests, and bug reports are still welcome.

How to use?

Go to https://techdoc-dashboard.toolforge.org, type the PagePile ID in the input field and click Load. If you don't have a specific collection of pages you are interested in, you can use a collection listed on the Documentation/Collections page. The application only supports collections of pages on MediaWiki.org, Wikitech, and Meta.

After loading the collection, click Open PagePile stats to display the dashboard for the collection. Note that this operation might take a while to complete.

To display the dashboard for any of the pages in the collection, scroll down to the Dashboards for individual pages widget and click a page title to display its dashboard.

Progress

Event Timeline

KBach renamed this task from Build a documentation metrics tool to Build a documentation metrics dashboard.Apr 17 2023, 12:09 PM
KBach changed the task status from Open to In Progress.
KBach triaged this task as Medium priority.
KBach updated the task description. (Show Details)

I assume the scope here is documentation which resides on public wikis? The Security-Team maintains (kind of) some public-facing documentation, mostly on mediawiki.org, under various security pages: https://www.mediawiki.org/wiki/Security et al.

I assume the scope here is documentation which resides on public wikis? The Security-Team maintains (kind of) some public-facing documentation, mostly on mediawiki.org, under various security pages: https://www.mediawiki.org/wiki/Security et al.

Initially, the focus is on content residing on mediawiki.org, wikitech, and meta, but we should be able to support any public wiki. We are also considering very limited support for content from doc.wikimedia.org in the future (even if no useful metrics are available).

KBach changed the status of subtask T334841: Implementation research from Open to In Progress.May 22 2023, 7:31 AM
KBach changed the status of subtask T334843: Implement MVP from Open to In Progress.May 25 2023, 8:39 AM

Version 1.0.0 (MVP) is now available: https://techdoc-dashboard.toolforge.org and this project is now done.

Improvements to the dashboard (based on the requirements not considered part of the core functionality, as well as any feedback) are tracked in T356976.

KBach updated the task description. (Show Details)