Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] App-specific debug instruction #2221

Open
chutten opened this issue May 3, 2024 · 0 comments
Open

[feature] App-specific debug instruction #2221

chutten opened this issue May 3, 2024 · 0 comments

Comments

@chutten
Copy link
Contributor

chutten commented May 3, 2024

The book of Glean has instructions about how to manually debug instrumentation per platform... but it lacks in satisfying users looking for a guide for specific instructions for a specific app.

For example, the docs do not (and arguably should not) mention the Firefox iOS UI for setting debug tags, or Firefox Desktop's about:glean interface, etc.

I think the Glean Dictionary is probably the best place we have (and the best place we intend to have in at least the medium term) for such guides.

This feature request is for:

  • A design of where in the Glean Dictionary this could live and how it could look (the app's top page? Above the fold? Text or images?)
  • A process for adding and editing this information. (do we link to the editor like Gleannotations? Do we make this part of integrating your app with Glean? Do we have a lint on the dictionary's build to ensure every app has something?)
  • Guides for debugging at least the handful of biggest projects, plus maybe default content (just link to the Book of Glean?) for the rest.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant