Skip to content

Added submodule for EyeLevel quickstart v4 - #107

Open
seanmerrow wants to merge 3 commits into
rh-ai-quickstart:mainfrom
seanmerrow:eyelevel-pub
Open

Added submodule for EyeLevel quickstart v4#107
seanmerrow wants to merge 3 commits into
rh-ai-quickstart:mainfrom
seanmerrow:eyelevel-pub

Conversation

@seanmerrow

Copy link
Copy Markdown

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

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)

@seanmerrow
seanmerrow requested a review from a team as a code owner July 21, 2026 20:03
Comment thread .gitmodules Outdated
[submodule "quickstart/agentic-software-factory"]
path = quickstart/agentic-software-factory
url = https://github.com/rh-ai-quickstart/agentic-software-factory.git
[submodule "quickstart/groundx-billing-extraction"]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

groundx-billing-extraction -> Billing-extraction-with-GroundX

these need to match. I will update docs accordingly

@ai-quickstart-automation

Copy link
Copy Markdown

WAITING ON AUTHOR: This PR is now waiting on new commits or comments from the author and will automatically close after 21 days. Simply comment to keep the PR open, or reopen if automatically closed.

@keklundrh keklundrh closed this Jul 22, 2026
@keklundrh keklundrh reopened this Jul 22, 2026
@keklundrh keklundrh closed this Jul 22, 2026
@keklundrh keklundrh reopened this Jul 22, 2026
@keklundrh keklundrh closed this Jul 22, 2026
@keklundrh keklundrh reopened this Jul 22, 2026
@keklundrh keklundrh closed this Jul 22, 2026
@keklundrh keklundrh reopened this Jul 22, 2026
@keklundrh keklundrh closed this Jul 22, 2026
@keklundrh keklundrh reopened this Jul 22, 2026
@keklundrh keklundrh closed this Jul 23, 2026
@keklundrh keklundrh reopened this Jul 23, 2026
@github-actions

Copy link
Copy Markdown

📋 Automated Documentation Review

Submodule: quickstart/Billing-extraction-with-GroundX
Source Repo: rh-ai-quickstart/Billing-extraction-with-GroundX
Commit: 61bd47c6533522a75d2356c61ce60685c7cdfb7d


📊 Summary

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

⚠️ Major Issues (3)

Trademark symbol used on non-first mention of GroundX

Category: style | Location: Opening paragraph and HTML comment SHORT DESCRIPTION

The trademark symbol ® appears after 'GroundX' in the opening paragraph ('using GroundX®') and again in the short description comment. According to the 'First Mention Rule', trademark symbols should only appear on the first mention of a product name. Subsequent mentions should omit the symbol.

Suggested Fix: Use 'GroundX®' only on the very first mention in the README. Change 'using GroundX®' to 'using GroundX' in the opening line, and remove the ® from the SHORT DESCRIPTION comment. Keep it only in the title if that's the first mention, or add it to the first body mention and remove from title.

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


Trademark symbol used on non-first mention of Red Hat OpenShift

Category: style | Location: Multiple locations: Requirements section, Minimum software requirements table, Prerequisites section

The trademark symbols appear multiple times throughout the document after 'Red Hat OpenShift®' (in Requirements section header 'Red Hat OpenShift® cluster', in table 'Red Hat OpenShift', etc.). Per the 'First Mention Rule', the full product name with ® should only appear once at first mention, with subsequent mentions using the approved short name without symbols.

Suggested Fix: Use 'Red Hat® OpenShift®' only on the first mention in the body text. All subsequent mentions should use 'OpenShift' or 'Red Hat OpenShift' without trademark symbols. Update the table entries and section headers to remove the ® symbol.

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


Unclear instructions for secret.yaml configuration

Category: content | Location: Deploy > Installation, step 2 note section

The Installation section states 'helm/billing-operators/secret.yaml is NOT OPTIONAL' but provides no guidance on what this file should contain, whether it needs to be created from an example, or what values are required. This creates confusion as the workloads secret.yaml is well-documented but the operators secret.yaml is mentioned only as 'NOT OPTIONAL' without further explanation.

Suggested Fix: Add clear instructions for the billing-operators secret.yaml file. Either: (1) explain that it doesn't require user configuration if that's the case, (2) provide an example file and document required values, or (3) clarify why it's mentioned as 'NOT OPTIONAL' if no user action is needed. Example: 'Note: helm/billing-operators/secret.yaml is included in the repository and requires no user modification.' or provide a step similar to step 2 for creating/configuring it.

Requirement: README Quality Standards > MAJOR criteria: Unclear instructions - Steps work but are confusing, lack context, or assume undocumented knowledge


ℹ️ Minor Issues (1)

Inconsistent table formatting in Required user permissions section

Category: formatting | Location: Requirements > Required user permissions section

The 'Required user permissions' table uses different formatting than other tables in the document. Some tables use center alignment for certain columns while this table doesn't, creating minor visual inconsistency across the README.

Suggested Fix: Consider standardizing table formatting across the document. Review whether columns like 'Required role' should be center-aligned to match the style of other tables (e.g., the Minimum hardware requirements table).

Requirement: README Quality Standards > MINOR criteria: Minor formatting inconsistencies


🤖 Automated review powered by Claude

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