This document is intended to help Mozilla's developers and data scientists analyze and interpret the data gathered by the Firefox Telemetry system.
At Mozilla, our data-gathering and data-handling practices are anchored in our Data Privacy Principles and elaborated in the Mozilla Privacy Policy.
To learn more about what data Firefox collects and the choices you can make as a user, please see the Firefox Privacy Notice.
The rendered documentation is hosted at https://docs.telemetry.mozilla.org/.
The documentation is rendered with mdBook. We use a fork named mdbook-dtmo that includes a number of custom additions to mdbook for our environment (for example, a plugin to automatically generate a table-of-contents).
You can download mdbook-dtmo on the GitHub releases page.
Please use the latest version.
Unpack it and place the binary in a directory of your $PATH.
If you have rustc already installed, you can install a pre-compiled binary directly:
curl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git badboy/mdbook-dtmoMake sure this directory is in your $PATH or copy it to a directory of your $PATH.
You can also build and install the preprocessors:
cargo install mdbook-dtmoYou can then serve the documentation locally with:
mdbook-dtmo serve
The complete documentation for the mdBook toolchain is available online at https://rust-lang.github.io/mdBook/. If you run into any problems, please let us know. We are happy to change the tooling to make it as much fun as possible to write.
See this article for detailed information on how to make additions or changes to the documentation.