docs: align README with AI quickstart standards - #19
Merged
Conversation
Restructure the root README for CONTRIBUTING section order and limits, and add a ROSA teardown section so Delete can link like ARO.
Hadar301
approved these changes
Jul 28, 2026
Hadar301
left a comment
Collaborator
There was a problem hiding this comment.
Great improvement for the docs!
Collaborator
|
this is a good structure. lets keep ARO and ROSA based deployment artifacts and docs separately. |
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.
Summary
Align the root README (and related docs) with rh-ai-quickstart CONTRIBUTING README structure requirements for AI quickstarts.
Requirements we addressed
cluster-adminfor ROSA/ARO;cluster-adminfor existing OpenShift.makecommands for existing OpenShift; links to ARO and ROSA teardown sections.What we changed
README.mdto match the quickstart section order (requirements H3s, validating, delete, tags).PCA_Deployment_ROSA/README.mdDestroying the Cluster (terraform destroy) so Delete can link like ARO.docs/requirements.mdto match OpenShift 4.20+ / RHOAI 3.4 (min 3.3) and simplified permissions wording.Test plan
#destroying-the-cluster, ROSA#destroying-the-cluster