github-samples / github-samples/pets-workshop
full-day workshop: Add Azure prerequisites, cost warning, and resource cleanup
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 80
- Forks
- 161
- Avg merge
- 31m
- Merged PRs (30d)
- 1
Description
Problem
The full-day README lists only a GitHub account and Copilot access as required resources, but Exercise 8 requires an Azure subscription, permission to create resources and identities, and GitHub permissions needed by azd pipeline config. The exercise provisions billable resources and ends without an azd down or equivalent cleanup step.
An independent learner can complete most of the day before discovering they cannot deploy, or leave paid resources running after the workshop.
Suggested change
Move deployment prerequisites to the workshop entry page and add an explicit teardown section after deployment verification.
Acceptance criteria
- The README states the Azure subscription and permission requirements before learners begin.
- Exercise 8 includes a preflight check for Azure and GitHub authentication/permissions.
- The workshop identifies that deployed resources may incur charges.
- A tested cleanup command such as
azd down --purgeis provided with an explanation of what it removes. - Learners verify the resource group and related credentials are removed.
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 with the full-day workshop README and Exercise 8, locating where prerequisites, deployment verification, and cleanup are documented. Check the Azure subscription, resource-creation and identity permissions, GitHub permissions for azd pipeline config, and the azd down --purge guidance. Done means the entry page and Exercise 8 cover the warnings, preflight checks, tested cleanup, and verification of removed resources and credentials.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, github
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100