Skip to content

fix: remove stale sections from manifests README#906

Merged
mergify[bot] merged 1 commit intomainfrom
fix/manifests-readme-835
Mar 13, 2026
Merged

fix: remove stale sections from manifests README#906
mergify[bot] merged 1 commit intomainfrom
fix/manifests-readme-835

Conversation

@ktdreyer
Copy link
Contributor

Summary

  • Remove the detailed directory-structure tree diagram that listed only 3 of the 5 overlays and omitted minikube/ and observability/. Replace with a brief prose list of top-level directories that won't go stale as files are added or removed.
  • Remove the "Migration Notes" section that referenced directories deleted long ago (e2e/manifests/, components/scripts/local-dev/manifests/).

Fixes #835

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>
@coderabbitai
Copy link

coderabbitai bot commented Mar 12, 2026

Walkthrough

Updated 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

Cohort / File(s) Summary
Manifests Documentation
components/manifests/README.md
Restructured README with consolidated layout sections, removed stale migration notes referencing non-existent directories, and added environment-specific deployment guidance (Production, E2E, Local Dev) with concrete commands and examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: removing stale sections from the manifests README.
Description check ✅ Passed The description is directly related to the changeset, explaining what stale content was removed and why.
Linked Issues check ✅ Passed The PR addresses all primary objectives from issue #835: removes stale migration notes and updates the directory structure documentation.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #835 requirements; no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/manifests-readme-835
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 | 🟡 Minor

Incorrect 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

📥 Commits

Reviewing files that changed from the base of the PR and between 1dee9f8 and 699163c.

📒 Files selected for processing (1)
  • components/manifests/README.md

@ambient-code ambient-code bot added this to the Review Queue milestone Mar 13, 2026
@mergify mergify bot added the queued label Mar 13, 2026
mergify bot added a commit that referenced this pull request Mar 13, 2026
@mergify mergify bot merged commit dd0bc67 into main Mar 13, 2026
25 checks passed
@mergify mergify bot deleted the fix/manifests-readme-835 branch March 13, 2026 13:20
@mergify
Copy link

mergify bot commented Mar 13, 2026

Merge Queue Status

This pull request spent 18 seconds in the queue, including 2 seconds running CI.

Required conditions to merge

@mergify mergify bot removed the queued label Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

manifests README is out of date

2 participants