Skip to content

docs(education): add Training module index and lesson 1 (what-agents-are)#779

Merged
potiuk merged 3 commits into
apache:mainfrom
justinmclean:education-training-lesson-01
Jul 8, 2026
Merged

docs(education): add Training module index and lesson 1 (what-agents-are)#779
potiuk merged 3 commits into
apache:mainfrom
justinmclean:education-training-lesson-01

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Scaffolds the first concrete Training lesson wrapper and AI tutor companion for the maintainer-education stream.

This adds the Lesson 1 classroom wrapper at docs/education/training/lesson-01-what-agents-are.md, covering per-lesson learning objectives, no-computer exercises, self-check questions, and answer keys on top of the existing “What agents are” source page. It also adds ai-tutors/lesson-01-what-agents-are.md plus a refresh script for injecting the source lesson knowledge base into tutor prompts.

The training module README now tracks the full 11-lesson map, with Lesson 1 as the first concrete delivery and later lessons/lab listed as placeholders. The source page and lesson wording were tightened around tool permissions, context limits, and probabilistic variation so the classroom wrapper and tutor prompt teach the same concepts consistently.

Generated-by: Claude (claude-sonnet-4-6)

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

…agents-are)

Scaffolds docs/education/apache-training/ with a module index (README.md)
and lesson-01-what-agents-are.md — the first LMS-neutral lesson wrapper
for the maintainer-education stream. Each lesson adds per-lesson learning
objectives, hands-on exercises, and self-check questions on top of the
existing source pages, shaped for upstream contribution to Apache Training.
The module map in the README lists all 11 lessons as placeholders; lesson 1
is the first concrete delivery.

Sub-item 1 of the education-apache-training-module epic (plan item 5).
The remaining lesson wrappers, the instructor/facilitator guide, and the
upstream-contribution hand-off are separate sub-items.

Generated-by: Claude (claude-sonnet-4-6)
@justinmclean

Copy link
Copy Markdown
Member Author

I run through the full AI prompt tutor manually - but would be interested in other people's views on this. I currently have drafts for the 10 others, but need to go through them manually one by one.

@justinmclean justinmclean self-assigned this Jul 8, 2026
@justinmclean justinmclean changed the title docs(education): add Apache Training module index and lesson 1 (what-agents-are) docs(education): add Training module index and lesson 1 (what-agents-are) Jul 8, 2026

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving — docs-only, and it checks out: every internal link resolves, SPDX headers are present on all new files, markdown is well-formed, and the AI-agent content is accurate and consistent with the existing docs/education/ pages. The couple of cosmetic nits (SPDX-vs-doctoc ordering in ai-tutors/README.md; the "Files" table listing tutor prompts that ship in later lessons) are non-blocking.

This is the base of the training-lesson stack (#779#780#781#782); once this lands, please rebase the others onto main so each reduces to its own lesson delta. Thanks @justinmclean.


This review was drafted by an AI-assisted tool and confirmed by a Magpie maintainer. The maintainer approving this PR has read the findings and signed off.

More on how Magpie handles maintainer review: CONTRIBUTING.md.

@potiuk potiuk merged commit 86c3a3a into apache:main Jul 8, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants