[docs-agent] Fix broken links, add missing index entries, update naming#679
Conversation
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 guidance, indexes, design examples, links, and platform terminology are updated across repository documentation. The GitOps cluster configuration example now uses revised templating expressions and formatting. ChangesDocumentation updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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: 2
🤖 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 `@CLAUDE.md`:
- Around line 106-111: Align the directory tree in CLAUDE.md with the structure
documented by .spec/README.md: clarify whether dashboard/, deploy/, hack/, and
scripts/ are top-level directories or children of .spec/, then update the
relevant documentation so both files consistently represent the actual layout,
including numbered feature directories and optional templates/.
In `@docs/design/gitops-cluster-configuration.md`:
- Around line 486-491: Add spec.goTemplate: true at the ApplicationSet spec
level containing the template that references .metadata.annotations.git_repo,
.metadata.annotations.git_revision, and .path.path, ensuring these Go-template
expressions render correctly.
🪄 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: 1c09eb15-bf63-4003-8c82-2f6bd3ed330a
📒 Files selected for processing (5)
CLAUDE.mddocs/README.mddocs/design/gitops-cluster-configuration.mddocs/design/maestro-mqtt-resource-distribution.mddocs/design/zoa-architecture.md
| .spec/ # Technical specifications | ||
| dashboard/ # PR dashboard (HTML/JS) | ||
| deploy/ # Per-environment deployment configs | ||
| hack/ # Developer utility scripts | ||
| scripts/ # Render and automation scripts | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Map the relevant files and inspect the claimed sections with line numbers.
git ls-files 'CLAUDE.md' '.spec/README.md' '.spec' | sed 's#^`#FILE` #'
printf '\n--- CLAUDE.md (around lines 90-130) ---\n'
sed -n '90,130p' CLAUDE.md | cat -n
printf '\n--- .spec/README.md (around lines 1-60) ---\n'
sed -n '1,60p' .spec/README.md | cat -n
# List the .spec directory contents to compare against the docs.
printf '\n--- .spec tree ---\n'
find .spec -maxdepth 2 -mindepth 1 | sortRepository: openshift-online/rosa-hyperfleet
Length of output: 5888
Align the .spec/ tree with .spec/README.md
CLAUDE.md shows dashboard/, deploy/, hack/, and scripts/ as siblings of .spec/, but .spec/README.md documents numbered feature directories plus optional templates/. Either indent the intended children or update one of the docs to match the actual layout.
🤖 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 `@CLAUDE.md` around lines 106 - 111, Align the directory tree in CLAUDE.md with
the structure documented by .spec/README.md: clarify whether dashboard/,
deploy/, hack/, and scripts/ are top-level directories or children of .spec/,
then update the relevant documentation so both files consistently represent the
actual layout, including numbered feature directories and optional templates/.
| repoURL: "{{ .metadata.annotations.git_repo }}" | ||
| revision: "{{ .metadata.annotations.git_revision }}" | ||
| template: | ||
| spec: | ||
| source: | ||
| path: '{{ .path.path }}' | ||
| path: "{{ .path.path }}" |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
git ls-files docs/design/gitops-cluster-configuration.md
printf '\n--- lines around 486-491 ---\n'
sed -n '460,520p' docs/design/gitops-cluster-configuration.md
printf '\n--- search for goTemplate in file ---\n'
rg -n 'goTemplate|metadata.annotations|path\.path|ApplicationSet|generators' docs/design/gitops-cluster-configuration.mdRepository: openshift-online/rosa-hyperfleet
Length of output: 7261
🌐 Web query:
Argo CD ApplicationSet goTemplate .metadata.annotations.git_repo .path.path requires goTemplate true docs
💡 Result:
In Argo CD ApplicationSet, the use of goTemplate: true at the spec level changes how template variables are accessed [1]. When goTemplate is enabled, variables such as .path become full objects rather than simple strings, requiring a change in the syntax used in your templates [1]. Specifically, the syntax for accessing path information must be updated as follows [1]: - Use {{ .path.path }} instead of {{ path }} [1]. - Use {{ .path.basename }} instead of {{ path.basename }} [1]. - Use {{ .path.basenameNormalized }} instead of {{ path.basenameNormalized }} [1]. - Use {{ .path.filename }} instead of {{ path.filename }} [1]. - Use {{ .path.filenameNormalized }} instead of {{ path.filenameNormalized }} [1]. - Use {{ index .path.segments n }} instead of {{ path[n] }} [1]. If goTemplate: true is not set in your ApplicationSet manifest, these variables will not be available as objects, and attempting to use the dot-notation (e.g., .path.path) will fail [2][1]. In such cases, you must use the standard (non-Go template) syntax [2]. To activate this feature, ensure your ApplicationSet manifest includes the following configuration [1][3]: spec: goTemplate: true # Optional: goTemplateOptions: ["missingkey=error"] template: spec: source: path: '{{.path.path}}' Additionally, if you are using a Matrix generator that combines multiple Git generators, you may need to use the pathParamPrefix option to avoid namespace collisions between the generated parameters, which would change the variable name to something like .myRepo.path [3][4].
Citations:
- 1: https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/GoTemplate/
- 2: ApplicationSet Git Generator documentation is incorrect argoproj/argo-cd#16819
- 3: https://argo-cd.readthedocs.io/en/release-2.9/operator-manual/applicationset/Generators-Git/
- 4: https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/applicationset-specification/
Enable goTemplate on this ApplicationSet.
This template uses Go-template field access (.metadata.annotations.git_repo, .metadata.annotations.git_revision, .path.path), but spec.goTemplate: true is missing here. Add it at the ApplicationSet spec level so these expressions render correctly.
🤖 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/gitops-cluster-configuration.md` around lines 486 - 491, Add
spec.goTemplate: true at the ApplicationSet spec level containing the template
that references .metadata.annotations.git_repo,
.metadata.annotations.git_revision, and .path.path, ensuring these Go-template
expressions render correctly.
1 participant
Automated Documentation Update
Changes Made (5 files, +26/−17)
High-priority fixes:
./001-fully-private-eks-bootstrap.md→./fully-private-eks-bootstrap.md) and removed reference to non-existentmaestro-agent-iot-provisioning.mdMedium-priority fixes:
Triggered By
Recent PRs (last 7 days):
Overall Documentation Validation:
Generated by Chai Bot documentation update task (weekly validation).
Summary by CodeRabbit