Merge pull request #1612 from mozilla/missed-a-spot-on-markdown-guidance

mozilla · May 5, 2021 · 6d19bb8 · 6d19bb8
2 parents 0d670fa + d2f10e8
commit 6d19bb8
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/user/user/adding-glean-to-your-project.md b/docs/user/user/adding-glean-to-your-project.md
@@ -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: