chore(metadata-completeness): Add descriptions to tables & views

[kwindau]

Description

This PR adds descriptions to the following views:

• firefox_desktop.adclick_history
• firefox_desktop.baseline_active_users
• firefox_desktop.baseline_active_users_aggregates
• firefox_desktop.desktop_engagement_aggregates
• firefox_desktop.desktop_installs
• firefox_desktop.desktop_retention_aggregates
• firefox_desktop.desktop_retention_clients
• firefox_desktop.fx_health_ind_antivirus
• firefox_desktop.fx_health_ind_bookmarks_by_country
• firefox_desktop.glean_baseline_clients_first_seen

And the following tables:

• firefox_desktop_derived.baseline_active_users_aggregates_v1
• firefox_desktop_derived.desktop_retention_clients_v1

Reviewer, please follow this checklist

[dataops-ci-bot]

Integration report for "chore(metadata-completeness): Add description for view"

sql.diff

Click to expand!

diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/dags/bqetl_analytics_aggregations.py /tmp/workspace/generated-sql/dags/bqetl_analytics_aggregations.py
--- /tmp/workspace/main-generated-sql/dags/bqetl_analytics_aggregations.py	2025-11-12 18:41:55.000000000 +0000
+++ /tmp/workspace/generated-sql/dags/bqetl_analytics_aggregations.py	2025-11-12 18:41:39.000000000 +0000
@@ -1009,7 +1009,6 @@
         project_id="moz-fx-data-shared-prod",
         owner="[email protected]",
         email=[
-            "[email protected]",
             "[email protected]",
             "[email protected]",
             "[email protected]",
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/adclick_history/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/adclick_history/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/adclick_history/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/adclick_history/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,8 +1,11 @@
 friendly_name: Adclick History
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Contains the number of ad-clicks per day for each Firefox Desktop client.
+  Primary key: client_id.
+owners:
+- [email protected]
+labels:
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,6 +1,10 @@
 friendly_name: Firefox Desktop Baseline Active Users
 description: |-
-  Please provide a description for the query
+  Contains 1 row for every client ID that has sent a baseline ping
+  in the last 28 days, with information from when they were last seen.
+  Also contains information from the client's first seen date,
+  like attribution information.
+  Primary Key: Client ID & Submission Date
 owners: []
 labels: {}
 workgroup_access:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users_aggregates/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users_aggregates/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users_aggregates/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/baseline_active_users_aggregates/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,14 @@
 friendly_name: Baseline Active Users Aggregates
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Aggregated information about daily, weekly, and monthly browser usage,
+  aggregated by date, country, OS,channel, etc.
+  Calculated from the Glean baseline ping.
+owners:
+- [email protected]
+- [email protected]
+labels:
+  owner1: kwindau
+  owner2: kignasiak
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_aggregates/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_aggregates/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_aggregates/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_aggregates/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,8 +1,11 @@
 friendly_name: Desktop Engagement Aggregates
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Contains aggregated DAU, WAU, and MAU by different attributes for engagement ratio calculation.
+owners:
+- [email protected]
+labels:
+  owner: kwindau
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_clients/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_clients/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_clients/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_engagement_clients/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,8 +1,12 @@
-friendly_name: Desktop Engagement Clients
+friendly_name: Desktop Engagement - Client Level
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Desktop engagement data at the client level, including attribution information
+  Primary Key: Submission Date + Client ID
+owners:
+- [email protected]
+labels:
+  owner: kwindau
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_installs/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_installs/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_installs/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_installs/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,11 @@
 friendly_name: Desktop Installs
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  This view contains information about Firefox desktop installs, to help track the acquisition funnel.
+owners:
+- [email protected]
+labels:
+  owner: kwindau
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_aggregates/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_aggregates/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_aggregates/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_aggregates/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,12 @@
 friendly_name: Desktop Retention Aggregates
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Calculates user retention 4 weeks after first seen date, by app version,
+  attribution information, channel, country, and more.
+owners:
+- [email protected]
+labels:
+  owner: kwindau
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_clients/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_clients/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_clients/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/desktop_retention_clients/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,8 +1,15 @@
-friendly_name: Desktop Retention Clients
-description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+friendly_name: Firefox Desktop Retention Clients
+description: "Measures 28-day (week-4) retention for Firefox Desktop clients anchored\
+  \ on a cohort \u201Cmetric date.\u201D\nMetric date represents the cohort of clients\
+  \ who were either:\nA) New on the metric date (first_seen_date = metric_date), or\n\
+  B) Seen on the metric date (sent a baseline ping that day).\nSubmission date represents\
+  \ the date 27 days after the metric date (end of the 28-day window), when week-4\
+  \ retention is evaluated.\nPrimary Key: Client ID + Metric Date"
+owners:
+- [email protected]
+labels:
+  owner: kwindau
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_antivirus/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_antivirus/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_antivirus/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_antivirus/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,10 @@
-friendly_name: Fx Health Ind Antivirus
+friendly_name: Firefox Health Indicator - Antivirus Usage Trends
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Aggregate table showing antivirus software usage by OS
+owners:
+- [email protected]
+labels:
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_bookmarks_by_country/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_bookmarks_by_country/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_bookmarks_by_country/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/fx_health_ind_bookmarks_by_country/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,12 @@
-friendly_name: Fx Health Ind Bookmarks By Country
+friendly_name: Firefox Health Indicator - Bookmarks By Country
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Aggregate table of bookmarks added per client per day per country.
+  Primary Key:
+  - Submission Date + Normalized Country Code
+owners:
+- [email protected]
+labels:
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/glean_baseline_clients_first_seen/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/glean_baseline_clients_first_seen/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/glean_baseline_clients_first_seen/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/glean_baseline_clients_first_seen/metadata.yaml	2025-11-12 18:35:58.000000000 +0000
@@ -1,8 +1,11 @@
 friendly_name: Glean Baseline Clients First Seen
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  For each client, looks at the first date we received a baseline ping, and calculates their attributes as of that first seen date.
+  Primary key: client_id.
+owners:
+- [email protected]
+labels:
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/ltv_states/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/ltv_states/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/ltv_states/metadata.yaml	2025-11-12 18:37:25.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop/ltv_states/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,8 +1,10 @@
-friendly_name: Ltv States
+friendly_name: Firefox Desktop LTV States
 description: |-
-  Please provide a description for the query
-owners: []
-labels: {}
+  Fields required for calculating LTV for Firefox Desktop clients
+owners:
+- [email protected]
+labels:
+  owner1: kwindau
 workgroup_access:
 - role: roles/bigquery.dataViewer
   members:
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/baseline_active_users_aggregates_v2/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/baseline_active_users_aggregates_v2/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/baseline_active_users_aggregates_v2/metadata.yaml	2025-11-12 18:37:26.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/baseline_active_users_aggregates_v2/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -3,7 +3,6 @@
   Builds active_users_aggregates using the baseline ping.
 owners:
 - [email protected]
-- [email protected]
 labels:
   incremental: true
   table_type: aggregate
diff -bur --no-dereference --new-file /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/desktop_retention_clients_v1/metadata.yaml /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/desktop_retention_clients_v1/metadata.yaml
--- /tmp/workspace/main-generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/desktop_retention_clients_v1/metadata.yaml	2025-11-12 18:37:26.000000000 +0000
+++ /tmp/workspace/generated-sql/sql/moz-fx-data-shared-prod/firefox_desktop_derived/desktop_retention_clients_v1/metadata.yaml	2025-11-12 18:35:57.000000000 +0000
@@ -1,6 +1,10 @@
 friendly_name: Desktop Retention Clients
-description: |-
-  Measures retention of new clients over time
+description: "Measures 28-day (week-4) retention for Firefox Desktop clients anchored\
+  \ on a cohort \u201Cmetric date.\u201D\nMetric date represents the cohort of clients\
+  \ who were either:\nA) New on the metric date (first_seen_date = metric_date), or\n\
+  B) Seen on the metric date (sent a baseline ping that day).\nSubmission date represents\
+  \ the date 27 days after the metric date (end of the 28-day window), when week-4\
+  \ retention is evaluated.\nPrimary Key: Client ID + Metric Date"
 owners:
 - [email protected]
 labels:

Link to full diff