Skip to content

Update RAG quickstart to v0.2.47 (MinIO to S4) - #147

Merged
keklundrh merged 1 commit into
rh-ai-quickstart:mainfrom
pzhao0:publish-rag-v0.2.47-s4
Oct 28, 2026
Merged

keklundrh merged 1 commit into
rh-ai-quickstart:mainfrom
pzhao0:publish-rag-v0.2.47-s4

Conversation

@pzhao0

@pzhao0 pzhao0 commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Publication suggestion PR

Thank you for suggesting a quickstart for publication on redhat(dot)com! Please complete the sections below fields so reviewers have enough context and leave checkboxes unchecked.

Summary

Update the published RAG quickstart from v0.2.44 to v0.2.47, bringing the catalog in sync with the released MinIO-to-S4 storage migration. The quickstart demonstrates document ingestion and retrieval-augmented generation for organizations building AI applications on Red Hat OpenShift AI.

Only the existing quickstart/RAG submodule pointer changes: 4ea3bca → a57760e (the v0.2.47 tag and current upstream main).

The release includes:

  • S4-backed S3-compatible storage through configure-pipeline 0.6.0 and aws-compatible-storage 0.2.0, replacing MinIO.
  • Updated ingestion notebook, sample-document uploads, storage configuration, and setup documentation. Documents use the documents bucket; pipeline artifacts use mlpipeline.
  • Intervening v0.2.45/v0.2.46 changes and the Service naming fix included in v0.2.47.

Source changes: S4 migration PR #210 and release PR #211.

Validation: confirmed the submodule commit matches the published v0.2.47 tag and upstream main, includes the S4 migration commit, and declares chart/app version 0.2.47 with configure-pipeline 0.6.0. git diff --check passes, and exactly one submodule changes. The upstream migration PR records OpenShift ingestion/retrieval validation and passing unit/integration checks; the release workflow passed. No new deployment was run for this publication-only update.

Publication readiness checklist

  • README is clear, concise, and free of typos
  • README is accurate and includes vertical use case
  • README is complete and follows template structure
  • Quickstart runs end-to-end without errors and is reproducible
  • Titles, descriptions, and tags adhere to MIST guidelines
  • Insert redhat(dot)com requirements here
  • Confirm markdown links use accessible "alt text" descriptions
  • Technical review complete
  • Peer review complete
  • Marketing review complete (accurately convey purpose of quickstart ->
    demo, not production-ready code supported by RH)
  • Known issues and requests are documented (or resolved)

@pzhao0
pzhao0 requested a review from a team as a code owner October 22, 2026 19:04
@github-actions

Copy link
Copy Markdown

📋 Automated Documentation Review

Submodule: quickstart/RAG
Source Repo: rh-ai-quickstart/RAG
Commit: a57760e90f92d5f78b34ac3b1318103fb965e2e4


📊 Summary

Severity Count
🚫 Blockers 0
⚠️ Major 3
ℹ️ Minor 2
💡 Suggestions 1
Total 6

⚠️ Major Issues (3)

Trademark symbol used on non-first mention of OpenShift AI

Category: style | Location: Requirements section > Minimum software requirements

In the 'Minimum software requirements' section, 'OpenShift AI' appears without a trademark symbol, but this is not the first mention in the document. The first mention appears in the 'Detailed description' section as 'OpenShift AI' (also without trademark). According to the 'First Mention Rule', the full product name with appropriate trademark symbol should be used on first mention only (e.g., 'Red Hat® OpenShift® AI'), and subsequent mentions can use approved short names without symbols.

Suggested Fix: Add trademark symbol to the first mention of OpenShift AI in the document (in the 'Detailed description' section under the table). Change 'OpenShift AI' to 'Red Hat® OpenShift® AI' on first mention only. All subsequent mentions should remain as 'OpenShift AI' without trademark symbols.

Requirement: Publishing Guidelines > Naming and branding consistency > The 'First Mention' Rule


Product name 'OpenShift Client CLI' may not follow official naming

Category: style | Location: Requirements section > Minimum software requirements

The 'Minimum software requirements' section lists 'OpenShift Client CLI - oc'. This should be verified against the Official Red Hat Product Names List (OPL) to ensure correct naming and trademark usage. The official name may be 'Red Hat OpenShift CLI' or similar.

Suggested Fix: Cross-reference the Official Red Hat Product Names List to verify the correct product name and trademark usage for the OpenShift CLI tool. Update to match the official naming convention.

Requirement: Publishing Guidelines > Naming and branding consistency > Use the Official List


Missing 'Delete' section as H3 under Deploy

Category: structure | Location: Deploy section - missing subsection

The README structure requirements specify that a 'Delete' section (H3) should appear under the 'Deploy' section (H2) to explain how to cleanly remove the quickstart when finished. This section is completely absent from the README.

Suggested Fix: Add a '### Delete' or '### Uninstall' subsection under the 'Deploy' section that provides clear instructions for removing all deployed components. Example: '### Delete\n\nTo remove the RAG quickstart from your cluster:\n\nbash\nmake uninstall NAMESPACE=llama-stack-rag\n\n\nThis will remove all pods, services, routes, and persistent volumes created during installation.'

Requirement: Contributing Guidelines > README structure requirements > Order 11: Delete (H3, Required)


ℹ️ Minor Issues (2)

Missing 'See it in action' section

Category: structure | Location: After 'Detailed description' section

The README structure requirements recommend including a 'See it in action' section (H3) with links to videos or Arcades for users without deployment environments. This section is absent, though it is marked as 'Recommended' rather than 'Required'.

Suggested Fix: Consider adding a '### See it in action' subsection after the 'Detailed description' that includes links to demo videos, Arcade interactive demos, or screenshots showing the chatbot interface in use. This helps users understand the quickstart before deploying.

Requirement: Contributing Guidelines > README structure requirements > Order 5: See it in action (H3, Recommended)


Missing 'Reference' section

Category: structure | Location: After 'Deploy' section, before 'Tags'

The README structure requirements recommend including a 'Reference' section (H2) with external links, blogs, and documentation. This section is absent, though it is marked as 'Recommended' rather than 'Required'.

Suggested Fix: Consider adding a '## Reference' section before the 'Tags' section that includes links to relevant documentation such as: LLaMA Stack documentation, RAG architecture best practices, OpenShift AI documentation, and any related blog posts or technical articles.

Requirement: Contributing Guidelines > README structure requirements > Order 12: Reference (H2, Recommended)


💡 Suggestions (1)

Consider adding AI transparency disclaimer in UI description

Category: content | Location: Detailed description section

The README describes a chatbot interface but does not mention whether AI-generated content is clearly labeled in the UI or if disclaimers prompt users to verify outputs. According to the 'AI Transparency in User Interfaces' best practices, users should clearly understand when AI is being used and be reminded to verify AI-generated content.

Suggested Fix: Consider adding a note in the 'Detailed description' or 'UI Layer' table row that describes how the Streamlit interface labels AI-generated responses and includes persistent disclaimers. Example: 'The Streamlit interface clearly labels all AI-generated responses and includes visible reminders for users to verify accuracy before using information in business decisions.'

Requirement: Contributing Guidelines > What Makes a Good Quickstart > AI Transparency in User Interfaces


🤖 Automated review powered by Claude

@ai-quickstart-automation

Copy link
Copy Markdown

SLA REMINDER: This PR has been pending review for 5 days. Publication-admin review target is 7 days.

@keklundrh
keklundrh merged commit 54ccce9 into rh-ai-quickstart:main Oct 28, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants