Skip to content

Commit 40611fe

Browse files
authored
Overall doc review (mozilla#366)
This includes quite a number of things, but the main goals were: * update, fix, or remove references to deprecated tools (like ATMO) * Add GCP data platform reference material, and shift the focus from the AWS pipeline to the GCP one * General cleanup, such as splitting long lines and using like references instead of inline links. Other things: * document `sample_id` * Fix a bunch of broken links * Update projects page
1 parent 598a250 commit 40611fe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1240
-1651
lines changed

.spelling

+3
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Colaboratory
5656
config
5757
CommonMark
5858
CPOW
59+
CRC
5960
CSV
6061
cutover
6162
dashboarding
@@ -187,6 +188,7 @@ Prefs
187188
prefs
188189
prepended
189190
protobuf
191+
PubSub
190192
pushlog
191193
PyPI
192194
PySpark
@@ -246,6 +248,7 @@ toolbars
246248
toolchain
247249
trailhead
248250
trailheads
251+
transpiler
249252
triaged
250253
triaging
251254
TTL

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
[![Linux Build Status](https://travis-ci.org/mozilla/firefox-data-docs.svg?branch=master)](https://travis-ci.org/mozilla/firefox-data-docs)
44

5-
This document is intended to help Mozilla's developers and data scientists analyze and interpret the data gathered
6-
by the Firefox Telemetry system.
5+
This document is intended to help Mozilla's developers and data scientists
6+
analyze and interpret the data gathered by the Firefox Telemetry system.
77

8-
At [Mozilla](https://www.mozilla.org), our data-gathering and data-handling practices are anchored in our
9-
[Data Privacy Principles](https://www.mozilla.org/en-US/privacy/principles/) and elaborated in the
10-
[Mozilla Privacy Policy](https://www.mozilla.org/en-US/privacy/).
8+
At [Mozilla](https://www.mozilla.org), our data-gathering and data-handling
9+
practices are anchored in our
10+
[Data Privacy Principles](https://www.mozilla.org/en-US/privacy/principles/)
11+
and elaborated in the [Mozilla Privacy Policy](https://www.mozilla.org/en-US/privacy/).
1112

12-
To learn more about what data Firefox collects and the choices you can make as a user, please see the
13-
[Firefox Privacy Notice](https://www.mozilla.org/en-US/privacy/firefox/).
13+
To learn more about what data Firefox collects and the choices you can make
14+
as a user, please see the [Firefox Privacy Notice](https://www.mozilla.org/en-US/privacy/firefox/).
1415

15-
You can find the [rendered documentation here](https://mozilla.github.io/firefox-data-docs/).
16+
The rendered documentation is hosted at [https://docs.telemetry.mozilla.org/](https://docs.telemetry.mozilla.org/).
1617

1718
This documentation is rendered with [mdBook](https://github.com/rust-lang/mdBook).
1819

src/SUMMARY.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@
1111
* [Getting Help](concepts/getting_help.md)
1212
* [Tools](tools/index.md)
1313
* [Project Glossary](tools/projects.md)
14-
* [Overview of Mozilla's Data Pipeline](concepts/pipeline/data_pipeline.md)
15-
* [In-depth Data Pipeline Detail](concepts/pipeline/data_pipeline_detail.md)
14+
* [Overview of Mozilla's Data Pipeline](concepts/pipeline/gcp_data_pipeline.md)
1615
* [HTTP Edge Server Specification](concepts/pipeline/http_edge_spec.md)
1716
* [Event Pipeline Detail](concepts/pipeline/event_pipeline.md)
17+
* [Previous AWS Pipeline Overview](concepts/pipeline/data_pipeline.md)
18+
* [In-depth AWS Data Pipeline Detail](concepts/pipeline/data_pipeline_detail.md)
1819
* [Analysis Interfaces](tools/interfaces.md)
1920
* [Custom analysis with Spark](tools/spark.md)
2021
* [SQL Style Guide](concepts/sql_style.md)
@@ -25,7 +26,6 @@
2526
* [Accessing and working with BigQuery](cookbooks/bigquery.md)
2627
* [Scheduling BigQuery Queries in Airflow](cookbooks/bigquery-airflow.md)
2728
* [Dataset Specific](cookbooks/dataset_specific.md)
28-
* [Working with Crash Pings](cookbooks/crash_pings.md)
2929
* [Working with Normandy events](cookbooks/normandy_events.md)
3030
* [Real-time](cookbooks/realtime.md)
3131
* [Creating a Real-time Analysis Plugin](cookbooks/realtime_analysis_plugin.md)
@@ -50,11 +50,9 @@
5050
* [Addons Daily](datasets/other/addons_daily/reference.md)
5151
* [Clients Daily](datasets/batch_view/clients_daily/reference.md)
5252
* [Clients Last Seen](datasets/bigquery/clients_last_seen/reference.md)
53-
* [Cross Sectional](datasets/batch_view/cross_sectional/reference.md)
5453
* [Events](datasets/batch_view/events/reference.md)
5554
* [Exact MAU](datasets/bigquery/exact_mau/reference.md)
5655
* [First Shutdown Summary](datasets/batch_view/first_shutdown_summary/reference.md)
57-
* [Longitudinal](datasets/batch_view/longitudinal/reference.md)
5856
* [Main Summary](datasets/batch_view/main_summary/reference.md)
5957
* [New Profile](datasets/batch_view/new_profile/reference.md)
6058
* [Socorro Crash Reports](datasets/other/socorro_crash/reference.md)
@@ -72,15 +70,16 @@
7270
* [Stub installer ping](datasets/other/stub_installer/reference.md)
7371
* [Activity Stream](datasets/other/activity-stream/reference.md)
7472
* [Obsolete Datasets](datasets/obsolete.md)
75-
* [Heavy Users](datasets/obsolete/heavy_users/reference.md)
76-
* [Crash Aggregates](datasets/obsolete/crash_aggregates/reference.md)
77-
* [Crash Summary](datasets/obsolete/crash_summary/reference.md)
73+
* [Churn](datasets/obsolete/churn/reference.md)
7874
* [Client Count](datasets/obsolete/client_count/reference.md)
7975
* [Client Count Daily](datasets/obsolete/client_count_daily/reference.md)
76+
* [Crash Aggregates](datasets/obsolete/crash_aggregates/reference.md)
77+
* [Crash Summary](datasets/obsolete/crash_summary/reference.md)
78+
* [Error Aggregates](datasets/obsolete/error_aggregates/reference.md)
79+
* [Heavy Users](datasets/obsolete/heavy_users/reference.md)
80+
* [Longitudinal](datasets/obsolete/longitudinal/reference.md)
8081
* [Retention](datasets/obsolete/retention/reference.md)
81-
* [Churn](datasets/obsolete/churn/reference.md)
8282
* [Sync Summary](datasets/obsolete/sync_summary/reference.md)
83-
* [Error Aggregates](datasets/obsolete/error_aggregates/reference.md)
8483
* [Firefox Accounts Datasets](datasets/fxa.md)
8584
* [Firefox Account Attribution](datasets/fxa_metrics/attribution.md)
8685
* [Firefox Account Funnel Metrics](datasets/fxa_metrics/funnels.md)
@@ -99,6 +98,7 @@
9998
* [Channel Normalization and Querying](concepts/channels/channel_normalization.md)
10099
* [Census metrics](concepts/censuses.md)
101100
* [Engagement metrics](concepts/engagement.md)
101+
* [Sampling](concepts/sample_id.md)
102102

103103
---
104104

0 commit comments

Comments
 (0)