Design and Build a Documentation System for Project FOG
Categories
(Toolkit :: Telemetry, task, P1)
Tracking
()
| Tracking | Status | |
|---|---|---|
| firefox76 | --- | fixed |
People
(Reporter: chutten, Assigned: chutten)
Details
(Whiteboard: [telemetry:fog:m2])
Attachments
(3 files)
glean_parser generates autodocs for metrics that we are going to want to publish in order to help satisfy Data Collection Review. These docs are markdown-formatted and can be output as part of the codegen step.
Project FOG will need concepts, design, and guiding documentation. It should not be part of the Book of Glean, but will want to reference it heavily. It might make sense to have the autodocs be integrated with these manual docs.
Documentation of Telemetry in m-c is written in restructured text, built with mach doc, and is served on firefox-source-docs.mozilla.org. It probably would be best to integrate with mach doc, and it seems possible that markdown-based documentation can be brought into the source docs without too much trouble.
Propose and build a system of documentation that rationalizes these disparate concepts and brings them together in a coherent way. Prioritize a system that is easy to read over one that is easy to write for.
|
Assignee | |
Updated•5 years ago
|
|
|
Assignee | |
Comment 1•5 years ago
|
||
|
||
Comment 2•5 years ago
|
||
Not sure what happened, but bugzilla is forcing me to download a text file (that then contains the gdocs link) instead of redirect me there. Maybe selected the wrong doc type?
|
|
||
Comment 3•5 years ago
|
||
Comment on attachment 9132377 [details]
Documentation Design
No objections here, I did leave one question in the doc though.
|
|
Assignee | |
Comment 4•5 years ago
|
||
|
|
Assignee | |
Comment 5•5 years ago
|
||
Okay, this one seems to work.
|
||
Updated•5 years ago
|
|
|
Assignee | |
Comment 6•5 years ago
|
||
|
||
Comment 8•5 years ago
|
||
| bugherder | ||
Description
•