{"id":13395699,"url":"https://github.com/mozilla/data-docs","last_synced_at":"2025-04-12T15:37:57.093Z","repository":{"id":37429823,"uuid":"81149676","full_name":"mozilla/data-docs","owner":"mozilla","description":"A guide for Mozilla's developers and data scientists to analyze and interpret the data gathered by our data collection systems.","archived":false,"fork":false,"pushed_at":"2025-04-09T18:42:43.000Z","size":193859,"stargazers_count":88,"open_issues_count":0,"forks_count":137,"subscribers_count":43,"default_branch":"main","last_synced_at":"2025-04-09T19:41:34.792Z","etag":null,"topics":["documentation","mozilla","mozilla-telemetry"],"latest_commit_sha":null,"homepage":"https://docs.telemetry.mozilla.org","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mozilla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-07T00:51:58.000Z","updated_at":"2025-04-09T18:42:23.000Z","dependencies_parsed_at":"2024-04-26T18:20:45.839Z","dependency_job_id":"346fd7cc-8fe8-4a18-8302-4efe512cee3e","html_url":"https://github.com/mozilla/data-docs","commit_stats":{"total_commits":898,"total_committers":100,"mean_commits":8.98,"dds":0.8585746102449888,"last_synced_commit":"8e3085dd6a4c1a28bd34276be379872eb0406659"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Fdata-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Fdata-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Fdata-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Fdata-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mozilla","download_url":"https://codeload.github.com/mozilla/data-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248590557,"owners_count":21129845,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","mozilla","mozilla-telemetry"],"created_at":"2024-07-30T18:00:28.479Z","updated_at":"2025-04-12T15:37:57.052Z","avatar_url":"https://github.com/mozilla.png","language":"Shell","funding_links":[],"categories":["📚 Bookshelf","Shell"],"sub_categories":[],"readme":"# Mozilla Data Documentation\n\n[![Build Status](https://github.com/mozilla/data-docs/workflows/Build/badge.svg)](https://github.com/mozilla/data-docs/actions?query=workflow%3ABuild)\n\nThis documentation was written to help Mozillians analyze and interpret data collected by our products, such as [Firefox](https://www.mozilla.org/firefox) and [Mozilla VPN](https://www.mozilla.org/products/vpn/).\n\nAt [Mozilla](https://www.mozilla.org), our data-gathering and data-handling\npractices are anchored in our\n[Data Privacy Principles](https://www.mozilla.org/en-US/privacy/principles/)\nand elaborated in the [Mozilla Privacy Policy](https://www.mozilla.org/en-US/privacy/).\n\nTo learn more about what data Firefox collects and the choices you can make\nas a user, please see the [Firefox Privacy Notice](https://www.mozilla.org/en-US/privacy/firefox/).\n\nThe rendered documentation is hosted at [https://docs.telemetry.mozilla.org/](https://docs.telemetry.mozilla.org/).\n\nIssues for this documentation are [tracked in Bugzilla][docszilla] ([file a bug]).\n\n[docszilla]: https://bugzilla.mozilla.org/buglist.cgi?product=Data%20Platform%20and%20Tools\u0026component=Documentation%20and%20Knowledge%20Repo%20%28RTMO%29\u0026resolution=---\n[file a bug]: https://bugzilla.mozilla.org/enter_bug.cgi?component=Documentation%20and%20Knowledge%20Repo%20(RTMO)\u0026product=Data%20Platform%20and%20Tools\n\n## Building the Documentation\n\nThe documentation is rendered with [mdBook](https://github.com/rust-lang/mdBook).\nWe use a fork named [mdbook-dtmo](https://github.com/badboy/mdbook-dtmo) that includes a number of custom additions to mdbook for our environment\n(for example, a plugin to automatically generate a table-of-contents).\n\nYou can download `mdbook-dtmo` on the [GitHub releases page](https://github.com/badboy/mdbook-dtmo/releases).\nPlease use the latest version.\nUnpack it and place the binary in a directory of your `$PATH`.\n\nIf you have [rustc](https://www.rust-lang.org/) already installed, you can install a pre-compiled binary directly:\n\n```bash\ncurl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git badboy/mdbook-dtmo\n```\n\nMake sure this directory is in your `$PATH` or copy it to a directory of your `$PATH`.\n\nYou can also build and install the preprocessors:\n\n```bash\ncargo install mdbook-dtmo\n```\n\nYou can then serve the documentation locally with:\n\n```\nmdbook-dtmo serve\n```\n\nThe complete documentation for the mdBook toolchain is available online at \u003chttps://rust-lang.github.io/mdBook/\u003e.\nIf you run into any problems, please [let us know](https://docs.telemetry.mozilla.org/concepts/getting_help.html). We are happy to change the tooling to make it as much fun as possible to write.\n\n### Spell checking\n\nArticles should use proper spelling, and pull requests will be automatically checked for spelling\nerrors.\n\nTechnical articles often contain words that are not recognized by common dictionaries, if this\nhappens you may either put specialized terms in `code blocks`, or you may add an exception to\nthe `.spelling` file in the code repository.\n\nFor things like dataset names or field names, `code blocks` should be preferred. Things like\nproject names or common technical terms should be added to the `.spelling` file.\n\nThe [markdown-spell-check](https://www.npmjs.com/package/markdown-spellcheck) package checks spelling as part of the build process. To run it locally, install [node.js](https://nodejs.org/en/) (if not already installed) and run `npm install` at the root of the repository. Then run the `scripts/spell_check.sh` script.\n\nYou may also remove the `--report` parameter to begin an interactive fixing session. In this\ncase, it is highly recommended to also add the `--no-suggestions` parameter, which greatly\nspeeds things up.\n\n### Link checking\n\nAny web links should be valid. A dead link might not be your fault, but you will earn a lot of good karma by fixing a dead link!\n\nThe [markdown-link-check](https://www.npmjs.com/package/markdown-link-check) package checks links as part of the build process. Note that dead links do not fail the build: links often go dead for all sorts of reasons, and making it a required check constantly caused otherwise-fine pull requests to appear broken. Still, you should check the status of this check yourself when submitting a pull request: you can do this by looking at the Travis CI status after submitting it.\n\nTo run link checking locally, run the installation steps [described for spell checking](#spell-checking) if you haven't already, then run the `scripts/link_check.sh` script.\n\n### Markdown formatting\n\nWe use [prettier](https://prettier.io) to ensure a consistent formatting style in our markdown.\nTo reduce friction, this is not a required check but running it on the files\nyou're modifying before submission is highly appreciated!\nMost editors can be configured to run prettier automatically,\nsee for example the\n[Prettier Plugin for VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).\n\nTo run prettier locally on the entire repository, run the installation steps\n[described for spell checking](#spell-checking) if you haven't already, then\nrun the `scripts/prettier_fix.sh` script.\n\n## Contributing\n\nSee [contributing](https://docs.telemetry.mozilla.org/contributing/index.html) for detailed information on making changes to the documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla%2Fdata-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmozilla%2Fdata-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla%2Fdata-docs/lists"}