View source for Data/WorkingGroups/GleanDictionary

= Quick Reference =

{| class="wikitable"
|-
| Development URL || [https://dictionary.telemetry.mozilla.org dictionary.telemetry.mozilla.org]
|-
| Development URL || [https://glean-dictionary-dev.netlify.app glean-dictionary-dev.netlify.app]
|-
| Source code || [https://github.com/mozilla/glean-dictionary mozilla/glean-dictionary on GitHub]
|-
| Matrix Channel || [https://chat.mozilla.org/#/room/#glean-dictionary:mozilla.org #glean-dictionary on chat.mozilla.org]
|-
| Meetings || No longer occurring (Glean Dictionary is occasionally discussed in the [https://wiki.mozilla.org/Data/WorkingGroups/GleanPlatform Glean Platform] meetings). For legacy minutes, see: [https://docs.google.com/document/d/1v7PV781CjmVNXxzlwzCNQvUT-AbpvE2n-cKe5gKI8zQ/edit Meeting Notes] 
|}

= Charter =

The focus of this working group is to produce a usable version of the Glean Dictionary, a [https://en.wikipedia.org/wiki/Data_dictionary data dictionary] for applications written using Glean SDK. This includes Firefox for Android and Firefox for iOS. As [https://firefox-source-docs.mozilla.org/toolkit/components/glean/index.html Firefox on Glean] comes together, the Glean Dictionary will also index the metadata sent by Firefox Desktop.

There are currently four planned phases for the project:

# (done) Index Glean metric and ping data produced by Glean applications, providing links to their representation in BigQuery
# (done) Index derived datasets produced by [https://github.com/mozilla/bigquery-etl bigquery-etl], creating generated documentation at [https://mozilla.github.io/bigquery-etl bigquery-etl]
# (in progress) Represent and link the dataset documentation outlined above in the Glean Dictionary
# (in progress) Add facilities to annotate glean metrics and pings with additional data and commentary useful for data scientists and other data practitioners at Mozilla

We are currently discussing what comes after this work is complete. Possible directions include integrations with Mozilla's Looker deploy and better support for Firefox Desktop (as [https://firefox-source-docs.mozilla.org/toolkit/components/glean/index.html it moves over to Glean]).

= Stakeholders = 

Glean team, Data science, the Data Taxonomy Effort, other consumers of data.

= Getting involved =

We welcome your feedback and involvement! We work in the open and anyone from the Mozilla community is welcome to join this group. This project involves a variety of pieces emphasizing different technologies, including:

* Building out the frontend (JavaScript, svelte)
* Working on the data infrastructure pieces to gather metadata (python, BigQuery)
* Improving data documentation and metadata definitions through Mozilla (markdown, yaml, python)

If you want to contribute, but aren't sure where to start, join our [https://chat.mozilla.org/#/room/#glean-dictionary:mozilla.org #glean-dictionary matrix channel] and say hi! Someone can probably find an initial task for you to work on.

= Communication =

There are two primary communication channels for the group:

* The #glean-dictionary channel on Matrix for quick questions
* Discussions in GitHub issues for design discussions and all other questions

Generally, discussions in GitHub issues is preferred since it can happen asynchronously and leaves a historical record that we can refer back to. For larger changes, consider writing a proposal (see below).

All project communications should follow the [https://www.mozilla.org/about/governance/policies/participation/ Mozilla Community Participation Guidelines].

= Coordination =

This group is currently being coordinated by Will Lachance (wlach on Github, Matrix, and Mozilla Slack), who is responsible for creating the meeting agenda and ensuring that discussions lead to a productive places. Feel free to get in touch if you have feedback or questions!

= Proposals =

{| class="wikitable"
|-
! Proposal !! Date !! Status
|-
| [https://docs.google.com/document/d/1mUHlWltHExFg9fD6dTDV98nIzrV7wRGgMw8783HDNfI/edit#heading=h.26qa4tdenv6x Glean Metric Annotation Repository] || 22 February 2021 || Implemented
|-
| [https://docs.google.com/document/d/1cCFldtc7Ki5kbAlCeIVQ6lPbzWl_DAMr46lCUAWRWGg/edit# Working Group Proposal] || 20 November 2020 || Accepted
|-
| [https://docs.google.com/document/d/1OkTWA3rsSJ0m5g9GDnxXVUMkJP-xJMQk_bDgDq-Z9xM/edit# Initial Proposal] || 10 August 2020 || Accepted
|-