[docs-agent] Update platform documentation — fix broken links, add missing index entries, convert ASCII to Mermaid#634
Conversation
…vert ASCII to Mermaid - CLAUDE.md: Replace Tekton with ZOA, add ZOA section, add ZOA to repo structure and key technologies, fix bootstrap-argocd.sh path, add adding-alerting-rules.md to tree - README.md: Add ZOA directories (images/zoa-tools, terraform/modules/zoa, zoa-job-pod-identity) to project structure - docs/README.md: Replace Tekton with ZOA in architecture, add 4 missing design docs (alerting-architecture, aws-iam-hosted-cluster-auth, regional-oidc-ownership, spec-to-pr-agent), add adding-component-pre-merge to how-to guides, add 4 terraform modules (pipeline-notifications, rhobs-api-gateway, zoa, zoa-job-pod-identity), remove broken presentation links - docs/FAQ.md: Replace Tekton with ZOA in RC description - docs/design/thanos-metrics-infrastructure.md: Add memory tuning section - docs/design/zoa-architecture.md: Convert Auth Flow and S3 Output Pipeline ASCII diagrams to Mermaid - docs/design/zoa-security-model.md: Convert Trust Boundaries ASCII diagram to Mermaid - docs/design/zoa-trusted-actions.md: Convert Dispatch Flow ASCII diagram to Mermaid - docs/environment-provisioning.md: Replace non-standard example AWS account ID Supersedes openshift-online#627. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
needs-ok-to-test
|
Hi @redhat-chai-bot. Thanks for your PR. I'm waiting for a openshift-online member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
📝 WalkthroughWalkthroughDocumentation-only changes: replaces Tekton references with ZOA, Maestro, and AWS CodePipeline across CLAUDE.md, README.md, docs/FAQ.md, and docs/README.md; converts ASCII diagrams in ZOA design docs to Mermaid flowcharts; expands doc indexes, Terraform module documentation, and repo structure; adds a Thanos memory tuning note; and corrects a bootstrap script path and example account ID. ChangesDocumentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/design/thanos-metrics-infrastructure.md (1)
126-129: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winConsider clarifying where Memory Tuning flags are applied.
The new Memory Tuning section explains the why and what of the flags well, but readers may wonder where these configurations are actually set in the codebase (Helm values, ThanosReceive CR, operator defaults, etc.). A brief inline reference or a note pointing to the relevant template file would help readers find and modify these settings.
For example, you could add a line like:
These flags are configured in the ThanosReceive CR template at [path/to/receiver.yaml](path/to/receiver.yaml).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/design/thanos-metrics-infrastructure.md` around lines 126 - 129, The Memory Tuning section explains what the flags do but does not specify where these configurations are actually applied in the codebase. Add a clarifying reference at the end of the section that indicates the location where these flags are set, such as the ThanosReceive CR template file, Helm values file, or operator defaults. For example, include a line like "These flags are configured in the ThanosReceive CR template at [path/to/receiver.yaml]" to help readers locate and modify these settings in the codebase.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/README.md`:
- Around line 80-83: The `zoa` and `zoa-job-pod-identity` module entries in the
README lack documentation links unlike the other modules listed above them.
Update both entries to follow the same format as `pipeline-notifications` and
`rhobs-api-gateway` by converting them to links pointing to their respective
README files at `../terraform/modules/zoa/README.md` and
`../terraform/modules/zoa-job-pod-identity/README.md`. If these README files do
not yet exist, create them with basic module documentation consistent with the
other module READMEs in the terraform/modules directory.
---
Nitpick comments:
In `@docs/design/thanos-metrics-infrastructure.md`:
- Around line 126-129: The Memory Tuning section explains what the flags do but
does not specify where these configurations are actually applied in the
codebase. Add a clarifying reference at the end of the section that indicates
the location where these flags are set, such as the ThanosReceive CR template
file, Helm values file, or operator defaults. For example, include a line like
"These flags are configured in the ThanosReceive CR template at
[path/to/receiver.yaml]" to help readers locate and modify these settings in the
codebase.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d130cc41-b259-428d-ab95-7bee05429348
📒 Files selected for processing (9)
CLAUDE.mdREADME.mddocs/FAQ.mddocs/README.mddocs/design/thanos-metrics-infrastructure.mddocs/design/zoa-architecture.mddocs/design/zoa-security-model.mddocs/design/zoa-trusted-actions.mddocs/environment-provisioning.md
| - [`pipeline-notifications`](../terraform/modules/pipeline-notifications/README.md) - SNS topics and subscriptions for pipeline alerts | ||
| - [`rhobs-api-gateway`](../terraform/modules/rhobs-api-gateway/README.md) - RHOBS API Gateway for cross-account metrics ingestion | ||
| - `zoa` - ZOA infrastructure (DynamoDB, S3, KMS, IAM) | ||
| - `zoa-job-pod-identity` - Per-cluster EKS Pod Identity for ZOA jobs |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check for README files in zoa modules
ls -la terraform/modules/zoa*/README.md 2>/dev/null || echo "No README files found in zoa modules"Repository: openshift-online/rosa-regional-platform
Length of output: 214
🏁 Script executed:
#!/bin/bash
# Check if zoa module directories exist
echo "=== Checking terraform/modules structure ==="
ls -d terraform/modules/zoa* 2>/dev/null || echo "zoa directories not found"
# Read the actual README.md file around lines 80-83
echo -e "\n=== Reading docs/README.md lines 75-90 ==="
sed -n '75,90p' docs/README.md
# Check if modules have any content
echo -e "\n=== Contents of zoa module directories ==="
for dir in terraform/modules/zoa*; do
if [ -d "$dir" ]; then
echo "Directory: $dir"
ls -la "$dir" | head -10
fi
doneRepository: openshift-online/rosa-regional-platform
Length of output: 2829
Add README files or links for zoa and zoa-job-pod-identity modules for documentation consistency.
The zoa and zoa-job-pod-identity Terraform modules exist at ../terraform/modules/zoa/ and ../terraform/modules/zoa-job-pod-identity/ but lack README.md files. Other module entries in this section link to ../terraform/modules/<module>/README.md—for consistency, either create README.md files for these modules or, at minimum, add directory links like the grafana-cloudwatch-logs entry.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/README.md` around lines 80 - 83, The `zoa` and `zoa-job-pod-identity`
module entries in the README lack documentation links unlike the other modules
listed above them. Update both entries to follow the same format as
`pipeline-notifications` and `rhobs-api-gateway` by converting them to links
pointing to their respective README files at
`../terraform/modules/zoa/README.md` and
`../terraform/modules/zoa-job-pod-identity/README.md`. If these README files do
not yet exist, create them with basic module documentation consistent with the
other module READMEs in the terraform/modules directory.
|
Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run. |
1 similar comment
|
Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run. |
|
Auto-closing: this documentation update was not reviewed within 3 days and has been superseded by a newer update. If the changes are still relevant, a new PR has been opened with targeted fixes. |
|
Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run. |
1 participant
Automated Documentation Update
Changes Made
9 files changed across CLAUDE.md, docs/README.md, README.md, docs/FAQ.md, and 3 ZOA design docs.
Triggered By
Recent PRs (last 7 days):
Overall Documentation Validation:
Undocumented areas noted (for human review):
Supersedes PR #627 (which covered a subset of these changes).
/cc @slopezz @jmelis @cdoan1 — please review these updates.
Generated by Chai Bot documentation update task (weekly validation).
Summary by CodeRabbit