mozilla / mozilla/probe-scraper
Document what to look out for for new apps
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 73
- Avg merge
- 10h
- Merged PRs (30d)
- 3
Description
With the recent treeherder addition I noticed that we don't really have good documentation around what happens for those new applications.
It should be all automated. But sometimes things break.
But how does a data engineer verify it worked?
How do they identify issues causes by the new product vs potential outside issues (that just got triggered by this)?
How to identify missing data because the CI task is missing vs missing data because of other failures?
It might be worthwhile to think about failure cases and document them.
User docs are here: https://mozilla.github.io/glean/book/user/adding-glean-to-your-project/enable-data-ingestion.html
We have generic gotchas documented here: https://github.com/mozilla/probe-scraper/blob/main/docs/common-failures.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading docs/common-failures.md and the linked Glean data-ingestion guide. Identify the failure cases around adding a new application, then document how a data engineer verifies ingestion and distinguishes CI-task, product, and outside failures; done means these checks and troubleshooting paths are recorded.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, data-engineering, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100