Added submodule for Codvo quickstart- v2

[braultatgithub]

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)

[github-actions]

📋 Automated Documentation Review

Submodule: quickstart/Agentic-Lease-Management-and-Reconciliation-with-Codvo
Source Repo: rh-ai-quickstart/Agentic-Lease-Management-and-Reconciliation-with-Codvo
Commit: 5695292a48ae6c67758b39b200196d8159a775ba

---

📊 Summary

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

---

🚫 Blockers (2)

Table of Contents references mismatched appendix labels

Category: structure | Location: Table of contents section, links to Appendices A and B

The Table of Contents lists 'Appendix A: external PostgreSQL or Redis' and 'Appendix B: GitOps', but the actual sections in the document are labeled 'Appendix A' with anchor '#appendix-b-external-postgresql-or-redis' and 'Appendix B' with anchor '#appendix-c-gitops'. This creates broken internal navigation links that prevent users from accessing critical deployment configuration information.

Suggested Fix: Fix the anchor references in the Table of Contents to match the actual section IDs. Change '(#appendix-b-external-postgresql-or-redis)' to '(#appendix-a-external-postgresql-or-redis)' and '(#appendix-c-gitops)' to '(#appendix-b-gitops)'. Alternatively, update the actual section anchor IDs to match the ToC.

Requirement: PUBLISHING.md - BLOCKER criteria: 'Broken README links: broken links to diagrams, internal or external links in the README file'

---

Deployment requires proprietary credentials not publicly available

Category: content | Location: Required user permissions section and Deploy > Install (one command) section

The quickstart requires users to email 'bala@codvo.ai' or 'indranil@codvo.ai' to obtain ACR pull credentials for 'rhleasingopsacr.azurecr.io'. This creates a manual approval barrier where users must wait for external parties to grant access, making the deployment impossible without human intervention and email-based credential distribution.

Suggested Fix: Either: (1) Make the container images publicly accessible without requiring email-based credential requests, (2) Provide an automated self-service credential distribution mechanism, or (3) Publish the images to a public registry like quay.io or ghcr.io. For Level 2 publication, users should be able to deploy without manual approval steps.

Requirement: PUBLISHING.md - BLOCKER criteria: 'Impossible deployment: Requires manual admin approval, emailing for license files, or access to resources not publicly available'

---

⚠️ Major Issues (3)

Trademark symbols used incorrectly on repeated mentions

Category: style | Location: Throughout document: Requirements section, Key technologies section, Minimum software requirements, and multiple other locations

The README uses trademark symbols (® or ™) on multiple mentions of product names throughout the document. Per Red Hat branding guidelines, trademark symbols should only appear on the first mention of a product name. Examples: 'Red Hat OpenShift AI' appears with potential trademark usage in multiple sections including Requirements, Key technologies, and Architecture sections.

Suggested Fix: Review the entire README and ensure trademark symbols (® for Red Hat®, OpenShift®) appear only on the very first mention of each product name in the document. All subsequent mentions should use the plain product name without symbols. Example: First mention 'Red Hat® OpenShift® AI', all later mentions 'Red Hat OpenShift AI' or approved short form 'OpenShift AI'.

Requirement: PUBLISHING.md - Naming and branding consistency: 'The First Mention Rule: Use the full product name with the appropriate trademark symbol on the first mention only'

---

Missing alt text for architecture diagram image

Category: structure | Location: Architecture section, image link

The architecture diagram image uses non-descriptive alt text: ''. The alt text 'NeIO LeasingOps architecture' is a literal description rather than functional alt text that explains what the diagram shows (components, data flow, relationships). This fails WCAG 2.2 AA accessibility standards.

Suggested Fix: Replace with descriptive alt text that explains the diagram's content, for example: '[Architecture diagram showing browser connecting to Next.js frontend, which proxies to FastAPI backend and LangGraph worker, with PostgreSQL and Redis for persistence, and vLLM serving Granite model through Llama Stack on OpenShift AI]'

Requirement: PUBLISHING.md - Content quality > Accessibility Analyzer: 'Alt Text: All images must have descriptive alt text that explains the function or meaning of the image, not just a literal description'

---

Instructions assume undocumented cluster-admin permissions

Category: content | Location: Required user permissions section

The 'Required user permissions' section states users need 'cluster-admin on the cluster, or admin on the target namespace', but the deployment creates cluster-scoped resources (ServiceAccount, SCC binding) that typically require cluster-admin. The instructions don't clarify what specific cluster-level permissions are needed or provide alternative approaches for users without cluster-admin access. This contradicts Level 3 requirements that quickstarts should work with regular user permissions.

Suggested Fix: Clarify the exact cluster-level permissions required (e.g., ability to create SecurityContextConstraints, ServiceAccounts with specific roles). If cluster-admin is truly required, document this as a current limitation and provide a roadmap for reducing permission requirements to meet Level 3 standards. Alternatively, restructure the deployment to work with namespace-admin permissions only.

Requirement: CONTRIBUTING.md - Level 3: Integrated requirements: 'No cluster admin permissions required' and PUBLISHING.md - MAJOR criteria: 'Unclear instructions: Steps work but are confusing, lack context, or assume undocumented knowledge'

---

ℹ️ Minor Issues (1)

Inconsistent code block formatting for CPU installation flag

Category: formatting | Location: Deploy > Install (one command) > CPU instead of GPU subsection

In the 'CPU instead of GPU when no GPU is available' subsection under Install, the code block shows installation flags but uses inconsistent formatting compared to other code blocks in the document. The flags are shown with line continuations but the formatting could be clearer about which flags are additions versus the base command.

Suggested Fix: Add a comment in the code block clearly indicating which flags are new for CPU mode, for example: '# Add these two flags for CPU-only inference:' before the values-leasingops-override.yaml line. This improves clarity without changing functionality.

Requirement: PUBLISHING.md - MINOR criteria: 'Minor formatting inconsistencies (heading levels off by one, inconsistent bullet styles)'

---

🤖 Automated review powered by Claude