Skip to content

Commit 5376de1

Browse files
committed
fix: address early trial readiness assessment findings
- Fix README.md: change inaccurate quick-reference.md to *-guide.md pattern - Add QUICKSTART-INSTRUCTOR.md: 5-step setup guide for first-time instructors - Add guides/learner-prerequisites.md: what farmers need before Session 1 - Track session thumbnails (4-8): commit previously untracked visual validation files Closes P0/P1 findings from readiness assessment.
1 parent f48d8d9 commit 5376de1

15 files changed

Lines changed: 243 additions & 2 deletions

QUICKSTART-INSTRUCTOR.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Instructor Quick Start
2+
3+
> Get ready to deliver your first GitHub for Farmers session in 5 steps.
4+
5+
## Before You Begin
6+
7+
- You should have access to the curriculum repository
8+
- Allow 2-3 hours for initial setup before your first cohort
9+
10+
---
11+
12+
## Step 1: Set Up the Demo Environment (1-2 hours)
13+
14+
The training uses a GitHub organization with demo repositories. You need:
15+
16+
| Repository | Purpose |
17+
|-----------|---------|
18+
| `demo-farm` | Primary training repo used in all 12 sessions |
19+
| `sunrise-acres-example` | Completed example showing full implementation |
20+
| `template-starter` | Minimal template learners fork in Session 12 |
21+
| `instructor-notes` | Private repo with answer keys and setup scripts |
22+
23+
**Option A: Use the pre-built environment**
24+
- Request access to `github4farms-training` organization
25+
- Verify you have Owner permissions
26+
27+
**Option B: Create your own environment**
28+
- Follow the complete setup in [delivery/demo-environment-spec.md](./delivery/demo-environment-spec.md)
29+
30+
---
31+
32+
## Step 2: Prepare Session Materials (30 min)
33+
34+
For each session you'll deliver:
35+
36+
1. **Open the slide deck**`sessions/session-NN/slides.pptx`
37+
2. **Review the facilitation script**`sessions/session-NN/facilitation-script.md`
38+
3. **Test the lab exercise** — Walk through `sessions/session-NN/lab-exercise.md` yourself
39+
4. **Print handouts** — See the print matrix in [delivery/logistics-checklist.md](./delivery/logistics-checklist.md)
40+
41+
**Tip:** Run through Session 1 completely before your first delivery. The facilitation script includes exact timing and talking points.
42+
43+
---
44+
45+
## Step 3: Collect Learner Information (1 week before)
46+
47+
You need each learner's:
48+
49+
- [ ] Full name (for certificates)
50+
- [ ] Email address
51+
- [ ] GitHub username (they create accounts at [github.com/signup](https://github.com/signup))
52+
53+
**Recommended username format:** `firstname-lastname-farm` (e.g., `john-smith-farm`)
54+
55+
Send organization invitations via GitHub:
56+
1. Go to your organization > People > Invite member
57+
2. Enter their GitHub username
58+
3. Set role to "Member"
59+
60+
Invitations expire in 7 days — send reminders!
61+
62+
---
63+
64+
## Step 4: Verify Environment (Day before Session 1)
65+
66+
Use the verification checklist in [delivery/demo-environment-spec.md](./delivery/demo-environment-spec.md#7-verification-checklist-pre-cohort):
67+
68+
- [ ] `demo-farm` is public and has 8+ Issues
69+
- [ ] All learners accepted organization invitations
70+
- [ ] Projector/screen sharing works with slide deck
71+
- [ ] You can access all demo repositories
72+
73+
---
74+
75+
## Step 5: Deliver Session 1
76+
77+
**Session 1 is read-only** — learners browse `demo-farm` without making changes.
78+
79+
| Phase | Time | Activity |
80+
|-------|------|----------|
81+
| Opening | 15 min | Welcome, introductions, farm analogies |
82+
| Instruction | 45 min | Navigate repository, find files, understand structure |
83+
| Practice | 60 min | Lab exercise exploring `demo-farm` |
84+
| Wrap-up | 15 min | Reflection, preview Session 2 |
85+
86+
**Don't forget:**
87+
- Farm analogies ground every concept (repository = digital barn)
88+
- 60-70% of time should be hands-on practice
89+
- Use the troubleshooting section in facilitation script
90+
91+
---
92+
93+
## Quick Reference Links
94+
95+
| Resource | Location |
96+
|----------|----------|
97+
| All session materials | `sessions/session-NN/` |
98+
| Facilitation scripts | `sessions/session-NN/facilitation-script.md` |
99+
| Lab exercises | `sessions/session-NN/lab-exercise.md` |
100+
| Demo environment setup | `delivery/demo-environment-spec.md` |
101+
| Logistics checklist | `delivery/logistics-checklist.md` |
102+
| Glossary (40+ terms) | `guides/glossary.md` |
103+
| Troubleshooting guide | `guides/troubleshooting.md` |
104+
105+
---
106+
107+
## Need Help?
108+
109+
- **Session-specific issues:** Check the troubleshooting section in each facilitation script
110+
- **Environment issues:** See [delivery/demo-environment-spec.md#8-troubleshooting-guide](./delivery/demo-environment-spec.md#8-troubleshooting-guide)
111+
- **Accessibility accommodations:** See [curriculum/accessibility-checklist.md](./curriculum/accessibility-checklist.md)
112+
113+
---
114+
115+
*You're ready! The curriculum is designed to be delivered as-is. Trust the facilitation scripts and focus on connecting with your learners.*

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## What This Is
1313

14-
A complete, ready-to-deliver training curriculum that teaches farmers how to use GitHub for farm management — task tracking, team collaboration, automation, and AI-assisted writing. Every session includes a slide deck (HTML + PowerPoint), lab exercise, quick-reference handout, and facilitation script.
14+
A complete, ready-to-deliver training curriculum that teaches farmers how to use GitHub for farm management — task tracking, team collaboration, automation, and AI-assisted writing. Every session includes a slide deck (HTML + PowerPoint), lab exercise, topic-specific guide, and facilitation script.
1515

1616
**No coding required.** Everything uses the GitHub web interface. Farm analogies ground every concept in familiar territory.
1717

@@ -42,7 +42,7 @@ Each session folder contains:
4242
- **`slides/`** — Individual HTML slides (720pt x 405pt, 16:9)
4343
- **`slides.pptx`** — Ready-to-present PowerPoint deck
4444
- **`lab-exercise.md`** — Hands-on activity with 3 farm scenario options
45-
- **`quick-reference.md`**Printer-friendly handout
45+
- **`*-guide.md`**Topic-specific printer-friendly handout (e.g., `issue-creation-guide.md`, `spark-agents-guide.md`)
4646
- **`facilitation-script.md`** — Timing, talking points, troubleshooting
4747
- **`accessibility-testing-log.md`** — WCAG 2.2 AA audit results
4848

guides/learner-prerequisites.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# What to Bring — Learner Prerequisites
2+
3+
> Everything you need before your first GitHub training session.
4+
5+
---
6+
7+
## Before Session 1
8+
9+
Complete these steps **at least 3 days before** your first session:
10+
11+
### 1. Create a GitHub Account (Free)
12+
13+
1. Go to [github.com/signup](https://github.com/signup)
14+
2. Use your email address
15+
3. Choose a username — we recommend: `firstname-lastname-farm`
16+
- Example: `maria-garcia-farm` or `john-smith-ranch`
17+
4. Choose the **Free** plan (no credit card needed)
18+
5. Verify your email address
19+
20+
**Write down your username and password!** You'll need them for every session.
21+
22+
### 2. Accept the Training Invitation
23+
24+
Your instructor will send you an email invitation to join the training organization.
25+
26+
1. Check your email for "You've been invited to join github4farms-training"
27+
2. Click the green **Join** button
28+
3. Sign in with your GitHub account
29+
30+
**Note:** Invitations expire in 7 days. If yours expired, ask your instructor for a new one.
31+
32+
---
33+
34+
## What to Bring to Each Session
35+
36+
### Required
37+
38+
| Item | Why You Need It |
39+
|------|-----------------|
40+
| **Laptop, tablet, or smartphone** | You'll work directly on GitHub.com |
41+
| **Your GitHub login** | Username and password |
42+
| **Internet connection** | All work happens online |
43+
44+
### Recommended
45+
46+
| Item | Why It Helps |
47+
|------|--------------|
48+
| **Notebook and pen** | Write down terms and ideas |
49+
| **Reading glasses** | If you need them for screens |
50+
| **Phone charger** | Sessions are 2-3 hours |
51+
52+
---
53+
54+
## Device Requirements
55+
56+
GitHub works on any device with a web browser. Here's what works best:
57+
58+
| Device | Works? | Notes |
59+
|--------|--------|-------|
60+
| **Laptop (Windows/Mac)** | Best | Full features, easiest to use |
61+
| **Tablet (iPad/Android)** | Good | Most features work |
62+
| **Smartphone** | Okay | Small screen, harder to navigate |
63+
| **Chromebook** | Good | Full features via browser |
64+
65+
**Minimum requirements:**
66+
- Updated web browser (Chrome, Firefox, Safari, or Edge)
67+
- Stable internet connection
68+
- Screen you can read comfortably
69+
70+
---
71+
72+
## No Device? No Problem
73+
74+
If you don't have a device or internet access:
75+
76+
- **Pair up** with another learner who has a device
77+
- **Use paper exercises** your instructor provides
78+
- **Observe** during demos and take notes
79+
- Ask your instructor about **borrowing a device** during sessions
80+
81+
---
82+
83+
## Common Questions
84+
85+
### Do I need to know coding?
86+
**No.** Everything uses the GitHub website. No command line, no programming.
87+
88+
### Do I need to pay for GitHub?
89+
**No.** The free account has everything you need.
90+
91+
### What if I forget my password?
92+
Go to [github.com](https://github.com) and click "Forgot password?" Use your email to reset it.
93+
94+
### Can I use my phone?
95+
**Yes**, but a laptop or tablet is easier. The phone screen is small for some tasks.
96+
97+
### What if I don't have an email address?
98+
Ask your instructor — they can help you create a free email account (Gmail, Outlook, etc.).
99+
100+
---
101+
102+
## Accessibility Support
103+
104+
Let your instructor know if you need:
105+
106+
- **Screen reader support** — GitHub works with VoiceOver and NVDA
107+
- **Larger text** — We can adjust font sizes
108+
- **Keyboard-only navigation** — All exercises work without a mouse
109+
- **Extra time** — Sessions include buffer time
110+
- **Printed materials** — Handouts available in large print
111+
112+
---
113+
114+
## Quick Checklist
115+
116+
Print this and check off before Session 1:
117+
118+
- [ ] Created GitHub account at github.com/signup
119+
- [ ] Wrote down my username: ________________
120+
- [ ] Accepted training organization invitation
121+
- [ ] Have a device with internet access
122+
- [ ] Know where and when Session 1 starts
123+
124+
---
125+
126+
*Questions? Contact your instructor before the first session.*
384 KB
Loading
85.3 KB
Loading

sessions/session-04/thumbnails.jpg

459 KB
Loading
376 KB
Loading
95.3 KB
Loading

sessions/session-05/thumbnails.jpg

437 KB
Loading
368 KB
Loading

0 commit comments

Comments
 (0)