Closed
Bug 1626574
Opened 6 years ago
Closed 6 years ago
Add best practices for adding Glean markdown docs to your project (for non-Android platforms)
Categories
(Data Platform and Tools :: Glean: SDK, enhancement, P3)
Data Platform and Tools
Glean: SDK
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: Dexter, Assigned: mdroettboom)
References
Details
(Whiteboard: [telemetry:glean-rs:m17][docdays])
Attachments
(1 file)
On non-Android platforms, getting the Glean autogenerated metrics docs (markdown) enabled may be a bit quirky. Swift has some instructions, but need to be verified.
For other bindings, for example Python, we do not clearly document how to enable markdown docs generation.
We should also make it clear that we have opinions about metric documentation: enabling docs generation should be a requirement for "adding glean to your project".
|
Reporter | |
Updated•6 years ago
|
Priority: -- → P3
Whiteboard: [telemetry:glean-rs:m?]
|
|
Reporter | |
Updated•6 years ago
|
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:m17][docdays]
|
Assignee | |
Updated•6 years ago
|
Assignee: nobody → mdroettboom
|
||
Comment 2•6 years ago
|
||
|
|
Assignee | |
Comment 4•6 years ago
|
||
Indeed. Thanks for the ping.
Status: NEW → RESOLVED
Closed: 6 years ago
Flags: needinfo?(mdroettboom)
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•