docs: add workshop release download notice to README#142
docs: add workshop release download notice to README#142Kalindi-Dev wants to merge 1 commit intoawslabs:mainfrom
Conversation
Kalindi-Dev
requested review from
a team,
harmjeff,
raj-jain-aws,
scottschreckengaust and
spraja08
README.md
Outdated
| --- | ||
|
|
||
| > [!NOTE] | ||
| > **For workshops, always download the latest release from the [Releases page](https://github.com/awslabs/aidlc-workflows/releases).** Release versions are tested and stable. The `main` branch contains ongoing development changes that may not yet be included in a release. |
There was a problem hiding this comment.
Recommend:
| > **For workshops, always download the latest release from the [Releases page](https://github.com/awslabs/aidlc-workflows/releases).** Release versions are tested and stable. The `main` branch contains ongoing development changes that may not yet be included in a release. | |
| > **For workshops, download the latest release from the [Releases page](https://github.com/awslabs/aidlc-workflows/releases).** Release versions are tested and stable. The `main` branch contains ongoing development changes that may not yet be included in a release. |
|
Modified the note to point to a pinned release as suggested by @harmjeff. |
| --- | ||
|
|
||
| > [!NOTE] | ||
| > **For workshops, we recommend using a pinned release version.** The current recommended release is [v0.1.6](https://github.com/awslabs/aidlc-workflows/releases/tag/v0.1.6). The `main` branch contains ongoing development changes that may not yet be included in a release. |
There was a problem hiding this comment.
The README Quick Start section already guides the user to download the zip https://github.com/awslabs/aidlc-workflows?tab=readme-ov-file#quick-start and not clone the repo so this addition seems redundant.
Further, the notion of a workshop in the project's README seems a bit misplaced. I think it confuses an ordinary consumer of this repo what a workshop means. Suggest that the person coordinating an AI-DLC workshop reinforce such an instruction with participants offline.
raj-jain-aws
left a comment
raj-jain-aws
left a comment
There was a problem hiding this comment.
The README Quick Start section already guides the user to download the zip https://github.com/awslabs/aidlc-workflows?tab=readme-ov-file#quick-start and not clone the repo so this addition seems redundant.
Further, the notion of a workshop in the project's README seems a bit misplaced. I think it confuses an ordinary consumer of this repo what a workshop means. Suggest that the person coordinating an AI-DLC workshop reinforce such an instruction with participants offline.
This change was meant to direct users who by default clone the repo to use release versions |
If you're running into issues with this with workshop participants, suggest updating the existing statement "Download the latest release zip from the Releases page ..." to highlight the importance of downloading zip over cloning. |
|
Closing the PR based on the feedback! |
Pull request was closed
4 participants
Summary
Add an informational notice to the README directing workshop participants to download from the Releases page instead of cloning main.
Changes
[!NOTE]block between the Table of Contents and Quick Start sections in README.mdmainmay contain changes not yet included in a releaseUser experience
Before: Workshop participants could clone or download from
main, potentially getting unreleased or unstable changes.After: A visible note directs workshop participants to the Releases page for tested, stable versions, and sets expectations that
maincontains ongoing development work.Checklist
Test Plan
[!NOTE]block renders correctly on GitHub---separator and the Quick Start headingAcknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.