Closed Bug 1341730 Opened 8 years ago Closed 8 years ago

Transfer and refactor telemetry-batch-view documentation to reference section

Categories

(Data Platform and Tools :: Documentation and Knowledge Repo (RTMO), defect, P1)

Product:
Data Platform and Tools
Component:
Documentation and Knowledge Repo (RTMO)
Type:
defect
Points:
3

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: harter, Assigned: harter)

References

Details

We have some documentation for the derived datasets here [0]. The documentation explaining implementation details and how to run the code should be kept where it is, in the telemetry-batch-view repository. However, the prose background information should be moved to the reference section of the comprehensive data docs [1] [0] https://github.com/mozilla/telemetry-batch-view/tree/master/docs [1] https://github.com/mozilla/firefox-data-docs/blob/master/datasets/reference.md
Depends on: 1341912
Depends on: 1341919
Priority: -- → P3
Assignee: nobody → rharter
Priority: P3 → P2
Moving to P2 since we're hoping to have this in Q2.
Depends on: 1358209
Component: Metrics: Pipeline → Documentation and Knowledge Repo (RTMO)
Product: Cloud Services → Data Platform and Tools
Priority: P2 → P1
Depends on: 1361862
This pr[0] added the docs to firefox-data-docs. Only remaining action item is deprecating and removing the docs in telemetry-batch-view. [0] https://github.com/mozilla/firefox-data-docs/pull/15
See Also: → 1364577
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.