mozilla / mozilla/probe-scraper

Document how to debug push function (Google Cloud Function)

Open
#653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
26
Forks
73
Avg merge
10h
Merged PRs (30d)
3

Description

probe-scraper deploys a Google Cloud Function, that is used by the CI task.
We should document how to access its log, how to test it locally, etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how probe-scraper deploys the Google Cloud Function and how the CI task invokes it. Document how to access its logs and how to test it locally; the work is done when a contributor can follow the documentation to investigate a failure and run the function without needing undocumented project knowledge.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, python
Domain
ci-cd, cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.