Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missed one part where we still recommend generating markdown for Mozilla projects #1612

Merged
merged 3 commits into from
May 5, 2021
Merged

Missed one part where we still recommend generating markdown for Mozilla projects #1612

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e61d174
Missed one part where we still recommend generating markdown for Mozi…
wlach May 3, 2021
5544732
Update adding-glean-to-your-project.md
wlach May 3, 2021
d2f10e8
Update docs/user/user/adding-glean-to-your-project.md
wlach May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/user/user/adding-glean-to-your-project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,9 @@ metrics.your_category.your_metric.set("value")

#### Documentation

The documentation for your application or library's metrics and pings are written in `metrics.yaml` and `pings.yaml`. However, you should also provide human-readable markdown files based on this information, and this is a requirement for Mozilla projects using the Glean SDK. For other languages and platforms, this transformation is done automatically as part of the build. However, for Python the integration to automatically generate docs is an additional step.
The documentation for your application or library's metrics and pings are written in `metrics.yaml` and `pings.yaml`.

For Mozilla projects, this SDK documentation is automatically published on the [Glean Dictionary](https://dictionary.telemetry.mozilla.org). For non-Mozilla products, it is recommended to generate markdown-based documentation of your metrics and pings into the repository. For most languages and platforms, this transformation can be done automatically as part of the build. However, for some language bindings the integration to automatically generate docs is an additional step.

The Glean SDK provides a commandline tool for automatically generating markdown documentation from your `metrics.yaml` and `pings.yaml` files. To perform that translation, run `glean_parser`'s `translate` command:

Expand Down