Open Bug 1677143 Opened 2 years ago Updated 2 months ago

[docs] collect data caveats in socorro docs

Categories

(Socorro :: General, task, P2)

Tracking

(Not tracked)

People

(Reporter: willkg, Unassigned)

References

Details

DTMO has a section on Common Analysis Gotchas:

https://docs.telemetry.mozilla.org/concepts/analysis_gotchas.html

That covers historical issues and caveats about the data that one would want to know when analyzing it.

In the crash-data universe, we have an unbelievable amount of this kind of data that's handed down using the oral tradition and in some cases is scrawled on the walls of train station bathroom stalls.

We should mirror the Analysis Gotchas and start writing these things down in a central location.

I think there are a couple of things here:

  1. we want to document weird things about the data visible when looking at those specific fields
  2. we want to list all the data weird things for the entire data set on a single page

We have schemas for the data now. We can capture the weird things in a new schema property and then expose them in the data dictionary on a field-by-field basis and create a new page that lists all the issues.

You need to log in before you can comment on or make changes to this bug.