catalyst-cooperative/pudl-usage-metrics

Usage metrics data dictionary

Opened this issue · 0 comments

Overview/Success criteria

We have all these metrics, and some folks have some hard-won context about what they all mean.

We don't need to create a full data dictionary here, but it's probably worth putting some documentation down so that people new to the usage metrics ETL & the dashboarding can learn:

  • how to access the usage metrics in Superset
  • how to find documentation about the column meanings for various log sources
    • S3
    • Kaggle
    • Zenodo
    • GitHub
    • ... anything else?

We don't want to spend a ton of time on this, so a best-effort set of documentation on the repo wiki with ~1-2 hours of work seems totally fine.

Next steps