fix: remove stale sections from manifests README#906
Conversation
The detailed directory tree only listed 3 of the 5 overlays and
omitted "minikube/" and "observability/", so it kept drifting from
reality. Replace it with a short prose list of top-level directories
that won't need updating every time a file is added.
The "Migration Notes" section referenced directories that were deleted
long ago ("e2e/manifests/", "components/scripts/local-dev/manifests/").
Remove it entirely.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
WalkthroughUpdated the manifests README documentation by removing outdated migration notes, restructuring the content into explicit base/overlays/observability sections, and replacing deprecated directory references with current environment-specific deployment guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 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)
📝 Coding Plan
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 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
components/manifests/README.md (1)
196-196:⚠️ Potential issue | 🟡 MinorIncorrect documentation link.
The link labeled "OpenShift Kustomize Guide" points to
working_with_quotas.html, which contains quota documentation instead of Kustomize content. Update the URL to reference the correct OpenShift Kustomize documentation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@components/manifests/README.md` at line 196, The README link text "OpenShift Kustomize Guide" points to the wrong page (working_with_quotas.html); update that anchor to the correct OpenShift Kustomize documentation URL (for example replace the href with the OpenShift Kustomize page such as https://docs.openshift.com/container-platform/latest/openshift_images/using_kustomize.html) so the link label and target both correctly reference the Kustomize guide.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@components/manifests/README.md`:
- Line 196: The README link text "OpenShift Kustomize Guide" points to the wrong
page (working_with_quotas.html); update that anchor to the correct OpenShift
Kustomize documentation URL (for example replace the href with the OpenShift
Kustomize page such as
https://docs.openshift.com/container-platform/latest/openshift_images/using_kustomize.html)
so the link label and target both correctly reference the Kustomize guide.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1ee46551-8c70-4a43-adfc-75418aea5619
📒 Files selected for processing (1)
components/manifests/README.md
Merge Queue Status
This pull request spent 18 seconds in the queue, including 2 seconds running CI. Required conditions to merge
|
Summary
minikube/andobservability/. Replace with a brief prose list of top-level directories that won't go stale as files are added or removed.e2e/manifests/,components/scripts/local-dev/manifests/).Fixes #835