Skip to content

Commit 3de4c4d

Browse files
author
GitHub Workshop Bot
committed
docs: update all documentation for Hybrid provisioning with GitHub App
1 parent 18bb113 commit 3de4c4d

9 files changed

Lines changed: 40 additions & 58 deletions

docs/00-pre-workshop-setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
>
1717
> **Please complete this guide at least one day before the workshop.** If you run into any issues, use the support hub at [Community-Access/support](https://github.com/Community-Access/support) so we can help - we want Day 1 to start with everyone ready to go, not troubleshooting.
1818
19-
If you want the most guided starting path, begin with [Get Going with GitHub](get-going.md). It explains how GitHub Classroom, your Learning Room repository, Challenge 1, evidence prompts, and tool choice all fit together before you start setup.
19+
If you want the most guided starting path, begin with [Get Going with GitHub](get-going.md). It explains how your Learning Room repository, Challenge 1, evidence prompts, and tool choice all fit together before you start setup.
2020

21-
> **Expect change across tools.** GitHub.com, GitHub Classroom, VS Code, GitHub Copilot, github.dev, browsers, extensions, and agent tools change regularly. The setup steps below are maintained against official sources, but exact labels, order, prompts, and availability can vary by account, organization policy, browser, operating system, and rollout. If something differs, pause, use headings/landmarks/labels or the VS Code Command Palette to explore, and ask for help with the exact page or prompt where you got stuck.
21+
> **Expect change across tools.** GitHub.com, VS Code, GitHub Copilot, github.dev, browsers, extensions, and agent tools change regularly. The setup steps below are maintained against official sources, but exact labels, order, prompts, and availability can vary by account, organization policy, browser, operating system, and rollout. If something differs, pause, use headings/landmarks/labels or the VS Code Command Palette to explore, and ask for help with the exact page or prompt where you got stuck.
2222
2323
## Table of Contents
2424

@@ -910,9 +910,9 @@ GIT & VS CODE (required before the workshop)
910910

911911
### What Happens at the Start of Day 1
912912

913-
You do **not** need to claim a workshop repository before Day 1 -- that is the very first hands-on step we do together in Block 0. When the workshop opens, the facilitator will paste a **GitHub Classroom assignment link** in the chat. Accepting that link creates your own private Learning Room repository in the workshop organization and seeds it with Challenge 1.
913+
You do **not** need to claim a workshop repository before Day 1 -- that is the very first hands-on step we do together in Block 0. When the workshop opens, the facilitator will share an **enrollment link** in the chat. Completing enrollment creates your own private Learning Room repository in the workshop organization and seeds it with Challenge 1.
914914

915-
The full guided walkthrough lives in [Chapter 4: Step-by-Step: Accept Your Classroom Assignment and Open Your Repo](04-the-learning-room.md#step-by-step-accept-your-classroom-assignment-and-open-your-repo). Skim it the night before if you want to know what to expect; we will walk through it live in Block 0.
915+
The full guided walkthrough lives in [Chapter 4: Step-by-Step: Get Your Learning Room Repository and Open Your Repo](04-the-learning-room.md#step-by-step-get-your-learning-room-and-open-your-repo). Skim it the night before if you want to know what to expect; we will walk through it live in Block 0.
916916

917917
## Other GitHub Access Methods (Reference Only)
918918

docs/04-the-learning-room.md

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,56 +7,41 @@
77
88
## What Is the Learning Room?
99

10-
The **Learning Room** is your **own private GitHub repository** for the workshop. When you accept the GitHub Classroom assignment in Block 0, GitHub copies the [`Community-Access/learning-room-template`](https://github.com/Community-Access/learning-room-template) repository into the workshop classroom organization as `<workshop-org>/learning-room-<your-username>`. That copy is yours to use for the workshop - you have write access, your own branches, your own pull requests, and your own automated feedback from Gandalf the PR validation bot.
10+
The **Learning Room** is your **own private GitHub repository** for the workshop. When you enroll in Block 0, the provisioning system creates a copy of the [`Community-Access/learning-room-template`](https://github.com/Community-Access/learning-room-template) repository in the workshop organization as `<workshop-org>/learning-room-<your-username>`. That copy is yours to use for the workshop - you have write access, your own branches, your own pull requests, and your own automated feedback from Gandalf the PR validation bot.
1111

12-
You do **not** work directly in `Community-Access/learning-room-template`. Think of the template as the clean master copy facilitators maintain. Your work happens in the private Learning Room repository created for you by GitHub Classroom.
12+
You do **not** work directly in `Community-Access/learning-room-template`. Think of the template as the clean master copy facilitators maintain. Your work happens in the private Learning Room repository created for you during enrollment.
1313

1414
Throughout this chapter and the rest of Day 1, "your Learning Room repository" or "your Learning Room repo" refers to this private copy. Every student gets one, and every copy starts from the same template files. You will not see other students' work in your repo, and they will not see yours - but everyone is doing the same challenges in parallel. Peer-simulation issues and pull requests inside your repo provide realistic collaboration practice, and facilitators may also pair students for real peer review when access is intentionally provided.
1515

16-
You do **not** need to create a GitHub organization or change repository permission settings. The workshop organization, template repository, Classroom assignment, and GitHub Actions permissions are managed by the facilitators.
16+
You do **not** need to create a GitHub organization or change repository permission settings. The workshop organization, template repository, provisioning system, and GitHub Actions permissions are managed by the facilitators.
1717

1818
## Why a Per-Student Repo?
1919

20-
GitHub Classroom gives each participant their own repository for three reasons:
20+
Each participant gets their own repository for three reasons:
2121

2222
- **Safety** -- you can experiment, break things, and recover without affecting anyone else
2323
- **Authenticity** -- you practice real repository work: issues, branches, pull requests, checks, reviews, and merging
2424
- **Pace** -- you progress through the 9 Day 1 challenges as fast or as slow as you need; nobody is waiting on you and you are not blocking anybody else
2525

2626
Real open source projects are shared spaces, and you will absolutely contribute to one on Day 2 (`accessibility-agents`) and through the Bonus C challenge. The Learning Room exists so you can build the muscle memory for issue, branch, PR, review, merge in a space where every mistake is a learning opportunity, not a public problem.
2727

28-
## Step-by-Step: Accept Your Classroom Assignment and Open Your Repo
28+
## Step-by-Step: Get Your Learning Room and Open Your Repo
2929

3030
This is the very first hands-on step of Day 1. By the end of this walkthrough you will have your own Learning Room repository on GitHub and your first challenge issue waiting for you. The whole flow takes about five minutes.
3131

3232
> **What you need before you start:**
3333
>
3434
> - A GitHub account you are signed into in your browser ([Pre-Workshop Setup, Step 1](00-pre-workshop-setup.md#step-1---create-your-github-account))
35-
> - The **Classroom assignment link** -- the facilitator pastes this link in the workshop chat at the start of Block 0. It looks like `https://classroom.github.com/a/<random-id>`. If you do not have it, ask in chat or DM the facilitator.
35+
> - The **enrollment link** -- the facilitator shares this link in the workshop chat at the start of Block 0. If you do not have it, ask in chat or DM the facilitator.
3636
37-
### 1. Open the assignment link
37+
### 1. Complete enrollment
3838

39-
1. In the same browser where you are signed into GitHub, open the Classroom assignment link the facilitator shared.
40-
2. The page that loads is hosted on `classroom.github.com`. Your screen reader announces a heading with the assignment name (for example, "Git Going with GitHub").
41-
3. If the page asks you to authorize **GitHub Classroom** to access your GitHub account, activate **Authorize GitHub Classroom**. This is a one-time step.
42-
43-
### 2. Identify yourself (if asked)
44-
45-
GitHub Classroom may ask you to pick your name from a roster so the facilitators can match your GitHub username to the registration list.
46-
47-
1. If a roster page appears, navigate the list with arrow keys or use Find-in-Page (`Ctrl+F` / `Cmd+F`) to search for your name.
48-
2. Activate the link or button next to your name.
49-
3. If you do not see your name on the roster, activate the **Skip to the next step** link and tell the facilitator in chat. They will reconcile the roster after your repo is created.
50-
51-
### 3. Accept the assignment
52-
53-
1. You now see a screen with a button that says **Accept this assignment** (or just **Accept the assignment**). Activate it.
54-
2. The page changes to a status screen that says something like "You are ready to go!" with a refresh option. GitHub Classroom is now copying the `learning-room-template` repository into the workshop classroom organization and granting you access to your private copy. This usually takes 10-30 seconds.
55-
3. Activate the **Refresh** link (or reload the page with `F5`) every 15 seconds or so until you see a link to your new repository. The link looks like `https://github.com/<workshop-org>/learning-room-<your-username>`.
56-
57-
> **Screen reader tip:** The status page does not auto-announce when the repo is ready. Use Browse mode and press `K` to step through links until you hear your repository link, or refresh the page until it appears.
58-
59-
### 4. Open your new repository
39+
1. Open the enrollment link the facilitator shared in your browser (where you are signed into GitHub).
40+
2. Fill in your profile information (name, email, GitHub experience level).
41+
3. Submit the form to file an enrollment issue.
42+
4. On the issue page, reply `ack` in a comment, then close the issue.
43+
5. The automation will process your enrollment and create your Learning Room repository. This usually takes 30-60 seconds.
44+
6. Once ready, you will receive a GitHub notification with a link to your new repository, or you can navigate to it directly at `https://github.com/<workshop-org>/learning-room-<your-username>`.
6045

6146
1. Activate the link to your repository. You land on the standard GitHub repo page for `<workshop-org>/learning-room-<your-username>`.
6247
2. Verify three things on this page:
@@ -65,7 +50,7 @@ GitHub Classroom may ask you to pick your name from a roster so the facilitators
6550
- You see folders like `docs/`, `.github/`, and files like `README.md`. These came from the template.
6651
3. Bookmark this page. You will return here for every Day 1 challenge.
6752

68-
### 5. Find your first challenge issue
53+
### 3. Find your first challenge issue
6954

7055
When your Learning Room repo is ready, **Challenge 1** appears as a GitHub issue in your repo. The facilitators prepare this by running the Student Progression Bot after students accept the Classroom assignment. The next challenges unlock one at a time as you close the previous ones.
7156

@@ -78,7 +63,7 @@ When your Learning Room repo is ready, **Challenge 1** appears as a GitHub issue
7863
> 1. Open the **Actions** tab and check whether the **Student Progression Bot** workflow ran successfully.
7964
> 2. If it failed or never ran, post a message in the workshop chat with the link to your repo. The facilitator can trigger `student-progression.yml` or create Challenge 1 from the issue template.
8065
81-
### 6. Confirm Gandalf can talk to you
66+
### 4. Confirm Gandalf can talk to you
8267

8368
The PR validation bot, **Gandalf**, posts educational feedback whenever you open a pull request. To confirm Gandalf is wired up, open the **Actions** tab in your repo and look for a workflow named **pr-validation-bot** (or **Gandalf PR Validation**). The workflow should appear in the list even before you have opened a PR. You do not need to run anything yet -- you just want to confirm it exists.
8469

docs/TOOLING-INVENTORY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Out of scope (excluded as noise):
2222
- `podcasts/logs/`, `tmp-*` files.
2323
- `podcasts/chapters/`, `podcasts/transcripts/`, `podcasts/bundles/`, `podcasts/challenge-bundles/` (regenerable build outputs).
2424
- `podcasts/llm-podcast-generator-review/generated/` (regression run outputs).
25-
- `node_modules/`, `.git/`, `epub/`, `learning-room/`, `classroom/` (out of reorg scope).
25+
- `node_modules/`, `.git/`, `epub/`, `learning-room/` (out of reorg scope).
2626

2727
Counts shown below are raw hits from ripgrep against the patterns `\bep[0-9]{2}\b`, `appendix-[a-z]+`, and `cc-bonus-[a-e]`.
2828

docs/course-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
>
99
> **Note:** Workshop content is being actively refined for the May 2026 cohort. Students should expect updates to materials leading up to and during the course.
1010
11-
> **Important: tools and websites change.** GitHub.com, GitHub Classroom, VS Code, GitHub Copilot, github.dev, browser extensions, and agent experiences are living products. We do our best to keep this curriculum current and source-backed, but labels, page order, shortcuts, preview features, model availability, and account-policy behavior can shift. If the documentation and your screen differ, use the exploration pattern taught in Chapters 2 and 3: orient by URL, page title, H1, landmarks, tab names, button labels, keyboard help, and the VS Code Command Palette. Then report the mismatch so the documentation can be corrected.
11+
> **Important: tools and websites change.** GitHub.com, VS Code, GitHub Copilot, github.dev, browser extensions, and agent experiences are living products. We do our best to keep this curriculum current and source-backed, but labels, page order, shortcuts, preview features, model availability, and account-policy behavior can shift. If the documentation and your screen differ, use the exploration pattern taught in Chapters 2 and 3: orient by URL, page title, H1, landmarks, tab names, button labels, keyboard help, and the VS Code Command Palette. Then report the mismatch so the documentation can be corrected.
1212
1313
## How This Course Works
1414

docs/get-going.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This workshop is designed so you are never left guessing what comes next. You will have:
88

9-
- A GitHub Classroom assignment link from the facilitator
9+
- An enrollment link from the facilitator to create your Learning Room
1010
- Your own private Learning Room repository
1111
- Challenge issues that tell you exactly what to do
1212
- Evidence prompts that tell you what to post when you finish
@@ -18,7 +18,7 @@ The goal is not to rush. The goal is to build confidence one checkable step at a
1818

1919
## When Tools or Pages Change
2020

21-
GitHub.com, GitHub Classroom, VS Code, GitHub Copilot, github.dev, browser extensions, and agent tools change often. This course is actively maintained, and we use official sources and live checks wherever possible, but your screen may not always match the exact wording in a step.
21+
GitHub.com, VS Code, GitHub Copilot, github.dev, browser extensions, and agent tools change often. This course is actively maintained, and we use official sources and live checks wherever possible, but your screen may not always match the exact wording in a step.
2222

2323
When that happens, do not assume you are failing. Use the same exploration skills the workshop teaches:
2424

@@ -36,17 +36,15 @@ Before Day 1 starts, complete [Chapter 00: Pre-Workshop Setup](00-pre-workshop-s
3636

3737
If you cannot finish every setup step before the workshop, tell a facilitator early. Setup problems are normal, and the workshop is designed with time and support for recovery.
3838

39-
## Step 2 - Accept the GitHub Classroom Assignment
39+
## Step 2 - Complete Your Enrollment
4040

41-
At the start of the workshop, the facilitator gives you a GitHub Classroom assignment link. It usually starts with `https://classroom.github.com/a/`. This single assignment covers both Day 1 and Day 2 content -- Day 2 challenges automatically unlock after you complete Day 1.
41+
At the start of the workshop, the facilitator shares an enrollment link. Complete the form to create your private Learning Room repository. Day 2 challenges automatically unlock after you complete Day 1.
4242

43-
1. Open the assignment link in the browser where you are signed in to GitHub.
44-
2. If GitHub asks you to authorize GitHub Classroom, activate **Authorize GitHub Classroom**.
45-
3. If you are asked to choose your name from a roster, find your name and select it. If your name is missing, use the skip option and tell the facilitator.
46-
4. Activate **Accept this assignment**.
47-
5. Wait while GitHub Classroom creates your private repository.
48-
6. Refresh the page until the repository link appears.
49-
7. Open the repository link and bookmark it.
43+
1. Open the enrollment link in the browser where you are signed in to GitHub.
44+
2. Complete the enrollment form with your details.
45+
3. An issue will be created in your account. Reply with acknowledgement (`ack`).
46+
4. Automation will provision your private Learning Room repository.
47+
5. Wait for the invitation email from GitHub, then open and bookmark your repository.
5048

5149
Your repository name usually looks like `learning-room-your-username`. This is your personal practice space for the workshop.
5250

docs/student-onboarding.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ If any step blocks you, tell us before the workshop. Setup problems are normal,
3030

3131
You do **not** need to accept a GitHub Classroom assignment before Day 1.
3232

33-
At the beginning of the workshop, the facilitator will share a GitHub Classroom assignment link in the meeting chat. That link creates your private Learning Room repository. We will walk through the process together.
33+
At the beginning of the workshop, the facilitator will share an enrollment link in the meeting chat. Completing enrollment creates your private Learning Room repository. We will walk through the process together.
3434

35-
Preview the steps in [The Learning Room: Accept Your Classroom Assignment and Open Your Repo](04-the-learning-room.md#step-by-step-accept-your-classroom-assignment-and-open-your-repo).
35+
Preview the steps in [The Learning Room: Get Your Learning Room and Open Your Repo](04-the-learning-room.md#step-by-step-get-your-learning-room-and-open-your-repo).
3636

3737
## What Your Learning Room Is
3838

3939
Your Learning Room is a private GitHub repository created from the `Community-Access/learning-room-template` template. It is your practice space for the workshop.
4040

41-
You do **not** clone or work directly in the template repository. GitHub Classroom makes a private copy for you, and that private copy is the repository you use during the workshop.
41+
You do **not** clone or work directly in the template repository. The provisioning system makes a private copy for you, and that private copy is the repository you use during the workshop.
4242

4343
Inside that repository you will find:
4444

@@ -48,7 +48,7 @@ Inside that repository you will find:
4848
- Gandalf, the workshop bot that gives feedback on pull requests
4949
- Reference files for branches, pull requests, merge conflicts, Copilot, and agents
5050

51-
Other students cannot see your private Learning Room repository. Facilitators can see it through GitHub Classroom so they can help when you get stuck.
51+
Other students cannot see your private Learning Room repository. Facilitators can see it so they can help when you get stuck.
5252

5353
You do **not** need a GitHub organization, owner access, or repository settings access. The facilitators configure the template, Classroom assignment, and GitHub Actions permissions before the workshop. Your job is to accept the assignment link, work in the repository it creates for you, and ask for help if a permission prompt appears.
5454

learning-room/.github/FACILITATOR_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@ Remember: **The bot enables human connection, not replaces it.**
241241
- [Automation Setup and Maintenance](./SETUP_AND_MAINTENANCE.md)
242242
- [Learning Room README](../README.md)
243243
- [Challenge Hub](../../docs/CHALLENGES.md)
244-
- [Grading Guide](../../classroom/grading-guide.md)
245244
- [Solutions Directory](../../docs/solutions/)
245+
- [Hybrid Provisioning Guide](../../admin/HYBRID_DEPLOYMENT_GUIDE.md)
246246

247247
**Questions?** Check the setup guide or reach out in your facilitator channel.
248248

0 commit comments

Comments
 (0)