Phase 4: README contributor guide and course setup commands reference - #14
Open
mirandastephane wants to merge 11 commits into
Open
Phase 4: README contributor guide and course setup commands reference#14mirandastephane wants to merge 11 commits into
mirandastephane wants to merge 11 commits into
Conversation
…tall Validates the Azul API response in course-setup.sh (bash) and wraps the Zulu CDN download in a try/catch in course-setup.ps1, surfacing actionable error messages when network calls fail.
…I url field Combines our error handling (set +e, response validation) with the upstream fix that updates the grep pattern from '"download_url"' to '"url"' to match the current api.azul.com response format.
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
1 participant
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.
Summary
This PR covers the documentation deliverables from Phase 4 of the 2026
maintenance window. It completes the contributor guide in the README and
provides the reference document for updating course lessons in the LMS.
Changes
ENBT-4111 · Update root README with new structure, script paths, and contributor guide
New sections added to README.md:
## Course Key Convention— documents the naming standard(
key = repo name minus "liferay-course-") with examples from allthree learning paths
## Adding a New Course— step-by-step guide with two subsections:course-setup.sh, and course-setup.ps1
## Troubleshooting— covers the three bugs fixed in Phase 1:ENBT-41110 · Course Environment Setup lessons update reference
A reference document (
ENBT-41110-course-setup-commands.md) has beengenerated with the updated commands for all 15 courses across the three
learning paths. This document will be used to update the LMS lessons
after this PR chain is fully merged into main.
Key changes reflected in every command:
content-manager-course-setup.sh→course-launcher/course-setup.shcontent-manager-course-setup.ps1→course-launcher/course-setup.ps16 Commerce course keys corrected (⚠️ flagged in the document):
--users-and-accounts→--commerce-users-and-accounts--product-management→--commerce-product-management--inventory-management→--commerce-inventory-management--pricing→--commerce-pricing--order-management→--commerce-order-management--storefronts→--commerce-storefrontsTesting
PR chain