Page MenuHomePhabricator

Metrics Platform wiki page audit
Closed, ResolvedPublic

Description

Complete a content audit for Metrics Platform and subpages on Wikitech as a top-down companion to the work done in T370335: Update guide to creating an instrument with Metrics Platform

Working spreadsheet: Google Sheet (shared publicly)

Landing pages

Main landing page: Metrics Platform/

Landing pages with only a few links that can be removed in favor of the main landing page:

  • Metrics Platform/Analytics
  • Metrics Platform/Decision Records
  • Metrics Platform/How to (content needs to be moved to the main page)
  • Metrics Platform/How to/Choose your language
  • Metrics Platform/How to/Journeys

User guides

Main guide: How to/Create First Metrics Platform Instrument

Supporting docs for the main guide:

  • How to/Create First Metrics Platform Instrument
  • How to/Create a Custom Schema
  • How to/Creating a Stream Configuration
  • How to/Setup Mediawiki for Metrics Platform
  • Implementations

Guides that need to be connected to a supporting doc:

  • How to/Validate Events
  • Sampling Units (Need to better understand what sampling units are)

FAQ

The FAQ page is the main high-level explanation for the Metrics Platform and its status. Once the project has reached a more stable state, we can convert this page to a narrative description. See {T371562#10070450}.

Pages that likely contain duplicated content and should be consolidated

  • Client/Implementations (What's the relationship between this and [[Implementations]]?)
  • Event Schema (May not be necessary, partial duplication of schema itself)
  • How to/Choose your language/Setup for JS
  • How to/Choose your language/Setup for Java
  • How to/Choose your language/Setup for PHP
  • How to/Decommission your instrument (should be redirected following policy clarity on long-lived instruments)
  • How to/Deploy your instrument
  • How to/Getting Started (Combine with setup guide)
  • Docs/Content/Writing mediawiki instrumentation code using eventlogging extension (Move to [[Implementations]])

Pages marked as outdated

  • Client (This seems like good content)

Pages that may no longer be relevant

To do: Follow up and figure out whether these pages are still relevant.

  • Analytics/Fragments
  • Client/Definition

Maintainer docs

These are out of scope for T329506: User Facing Metrics Platform Documentation

  • Custom Data Monitor
  • How to/Contribute
  • How to/Deploy a New Client Library Version

Team processes

  • Demos (no longer used)

Decision records

  • Decision Records/Deprioritize Custom Data
  • Decision Records/Single Table Per Base Schema