HYPERFLEET-1186 - docs: restructure documentation into focused guides#181
HYPERFLEET-1186 - docs: restructure documentation into focused guides#181sherine-k wants to merge 1 commit into
Conversation
|
[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 |
Risk Score: 2 —
|
| Signal | Detail | Points |
|---|---|---|
| PR size | 2109 lines (>500) | +2 |
| Sensitive paths | none | +0 |
Computed by hyperfleet-risk-scorer
sherine-k
force-pushed
the
HYPERFLEET-1186
branch
from
3eb5e11 to
f187c86
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (16)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (11)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughSummary by CodeRabbit
Walkthrough
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error, 1 warning)
✅ Passed checks (9 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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
♻️ Duplicate comments (1)
AGENTS.md (1)
64-64:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix redundant table cell text that was previously flagged.
Line 64 repeats "GKE dev deployment" in both the label and description, causing Markdown table rendering issues (as noted in a prior review). The description should contain only the link:
| GKE dev deployment | [docs/sentinel-for-gke-dev.md](docs/sentinel-for-gke-dev.md) |✂️ Proposed fix
- | GKE dev deployment | [docs/sentinel-for-gke-dev.md](docs/sentinel-for-gke-dev.md) for GKE dev deployment | + | GKE dev deployment | [docs/sentinel-for-gke-dev.md](docs/sentinel-for-gke-dev.md) |🤖 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 `@AGENTS.md` at line 64, The GKE dev deployment table row in AGENTS.md contains redundant text where "GKE dev deployment" is repeated in both the label column and in the description column. Remove the text "for GKE dev deployment" from the second column of this table row, keeping only the markdown link [docs/sentinel-for-gke-dev.md](docs/sentinel-for-gke-dev.md) in the second column. This eliminates the redundancy that causes Markdown table rendering issues.
🤖 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/sentinel-for-gke-dev.md`:
- Line 197: The kubectl port-forward command for sentinel-test service is
incomplete and only forwards port 8080, but the metrics endpoint runs on port
9090. Update the port-forward command to include both ports (8080:8080
9090:9090) to match the pattern in deployment.md. Additionally, update the curl
command that queries the metrics endpoint to use localhost:9090/metrics instead
of localhost:8080/metrics to correctly access the metrics endpoint. Check line
308 in the troubleshooting section and apply the same fixes if the incomplete
port-forward command appears there as well.
---
Duplicate comments:
In `@AGENTS.md`:
- Line 64: The GKE dev deployment table row in AGENTS.md contains redundant text
where "GKE dev deployment" is repeated in both the label column and in the
description column. Remove the text "for GKE dev deployment" from the second
column of this table row, keeping only the markdown link
[docs/sentinel-for-gke-dev.md](docs/sentinel-for-gke-dev.md) in the second
column. This eliminates the redundancy that causes Markdown table rendering
issues.
🪄 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: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 3bdb56b4-4f7e-44c8-8634-106588d6ede2
📒 Files selected for processing (16)
AGENTS.mdCONTRIBUTING.mdREADME.mdcharts/README.mdcharts/README.md.gotmpldocs/alerts.mddocs/config.mddocs/deployment.mddocs/development.mddocs/metrics.mddocs/multi-instance-deployment.mddocs/resource-profiling.mddocs/runbook.mddocs/running-sentinel.mddocs/sentinel-for-gke-dev.mddocs/sentinel-operator-guide.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
openshift-hyperfleet/architecture(manual)openshift-hyperfleet/hyperfleet-api(manual)openshift-hyperfleet/hyperfleet-sentinel(manual)openshift-hyperfleet/hyperfleet-adapter(manual)openshift-hyperfleet/hyperfleet-broker(manual)
💤 Files with no reviewable changes (1)
- docs/running-sentinel.md
sherine-k
force-pushed
the
HYPERFLEET-1186
branch
2 times, most recently
from
e86a8e0 to
63e6283
Compare
Slim down README to a concise overview with link tables pointing to dedicated guides, and reorganize scattered content into topic-specific documents with clear audience headers. - Extract development setup into docs/development.md - Extract Helm deployment and broker/monitoring setup into docs/deployment.md - Restructure docs/config.md from prose into table-based reference format - Rename docs/running-sentinel.md to sentinel-for-gke-dev.md, and narrow to GKE-only scope (local dev moved out) - Remove duplicated configuration examples and observability sections from README - Update cross-references in AGENTS.md, CONTRIBUTING.md, charts/, and all docs/ - Fix port for querying metrics in docs/sentinel-for-gke-dev.md
sherine-k
force-pushed
the
HYPERFLEET-1186
branch
from
63e6283 to
7ceb712
Compare
2 participants
Summary
Slim down README to a concise overview with link tables pointing to
dedicated guides, and reorganize scattered content into topic-specific
documents with clear audience headers.
HYPERFLEET-1186
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)