Repository navigation
Simplify and unwrap workshop READMEs - #23
Merged
Ben Constable (BenConstable9) merged 2 commits intoOct 28, 2026
Merged
Conversation
Keep setup instructions, lab details, and real-world CI/CD enablement while removing repetition and linking to maintained definitions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep the visual path from development through promotion, with accurate source-editing guidance and explicit CI/CD enablement and approval caveats. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the documentation cleanup and clarification of workshop guidance.
No open issues 🎉
What changed in this PR
Streamlines all 22 workshop READMEs while retaining setup guidance, lab instructions, and operational caveats. Changes are documentation-only; runtime code and workflows are unchanged.
Changes:
- Removes repetition and manual prose wrapping, and adds links to notebooks and resource definitions.
- Clarifies current CI/CD limitations and the configuration needed to enable production deployments.
- Updates
solution/documentation and regenerates matching attendee READMEs undersrc/.
| File | Description |
|---|---|
src/training/README.md |
Shortens training guidance and links the notebook. |
src/README.md |
Adds linked, concise stage descriptions. |
src/monitoring/README.md |
Condenses monitoring and drift-demo descriptions. |
src/feature_engineering/README.md |
Clarifies personal and shared output schemas. |
src/exploration/README.md |
Simplifies optional EDA guidance. |
src/deployment/README.md |
Links deployment and batch-inference modules. |
src/deployment/model_deployment/README.md |
Condenses deployment-task and endpoint-test descriptions. |
src/deployment/batch_inference/README.md |
Links and summarizes batch scoring. |
src/data_ingestion/README.md |
Simplifies instructor-only ingestion guidance. |
solution/training/README.md |
Shortens the reference training description. |
solution/README.md |
Adds linked summaries of reference stages. |
solution/monitoring/README.md |
Condenses reference monitoring descriptions. |
solution/feature_engineering/README.md |
Documents resolved ML schema names. |
solution/exploration/README.md |
Clarifies interactive, read-only EDA usage. |
solution/deployment/README.md |
Summarizes and links deployment modules. |
solution/deployment/model_deployment/README.md |
Summarizes evaluation, approval, deployment, and testing. |
solution/deployment/batch_inference/README.md |
Simplifies the batch-inference description. |
solution/data_ingestion/README.md |
Condenses ingestion setup and notebook descriptions. |
scripts/README.md |
Links and summarizes the attendee-source generator. |
resources/README.md |
Links resource definitions and clarifies their purposes. |
README.md |
Consolidates setup, labs, isolation, and CI/CD guidance. |
.github/workflows/README.md |
Documents current checks, disabled deployment triggers, and adoption requirements. |
Review effort: Balanced
Ben Constable (BenConstable9)
deleted the
benconstable9-readme-simplification
branch
October 28, 2026 16:58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cut repetition and manual prose wrapping across all 22 READMEs while keeping setup commands, dataset details, lab instructions, and operational caveats. Replace copied workflow YAML with links to the maintained definitions and regenerate the attendee READMEs from
solution/.Keep the real-world CI/CD setup, including triggers, OIDC, service principals, and approval gates. Clarify that automatic deployments are intentionally disabled in this public repo and explain what adopters need to enable.
Checked relative links and heading anchors, generated README parity, and Markdown structure. Compared the revisions against the originals for lost information. Documentation only; no runtime or workflow changes.