docs: align docs with v1beta1-only API - #185
Conversation
Remove stale v1alpha1 and conversion-webhook references after the v0.15.0 hard cut, document the terminal authentication retry flag, and preserve the stored-version migration condition.
REVIEW — mkurator/status-deck-doc-nits @
|
| Gate | Result |
|---|---|
go build ./... |
✅ |
task verify |
✅ |
task lint + arch-lint |
✅ |
task test:run |
✅ |
| Coverage | ✅ internal 92.6%; API 92.5% |
task scrub |
✅ |
| Markdown lint | ✅ 90 files, 0 errors |
mkdocs build --strict |
✅ |
task helm:test |
✅ 22 tests |
task vuln:check |
✅ |
| Paper-gate check | N/A — documentation-only |
No findings. The v1beta1-only API/layout, stored-version migration condition, and terminal retry flag match current source, ADR-0014, and ADR-0029.
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect MKurator’s post-v0.15.0 reality: a v1beta1-only served/stored API (no conversion webhook), plus a small runtime flag documentation addition. This keeps user and developer guidance consistent with the current repo layout and operator behavior.
Changes:
- Remove/replace stale references to
v1alpha1and the conversion webhook across key docs. - Align repository layout and webhook path documentation with
api/v1beta1andinternal/webhook/v1beta1. - Document the
--terminal-retry-intervalruntime flag for terminal-auth recovery behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Updates supported-versions statement to pre-1.0 with v1beta1 as the only served API. |
| README.md | Removes conversion-webhook messaging; adds upgrade runbook link and updates repo layout snippet. |
| docs/PHASE5_AUTH_SKETCH.md | Updates GitHub source links from api/v1alpha1 to api/v1beta1. |
| docs/OPERATOR_RUNTIME.md | Updates scheme/webhook references to v1beta1 and documents --terminal-retry-interval. |
| docs/DEVELOPER_GUIDE.md | Updates CRD editing and webhook wiring paths to api/v1beta1 and internal/webhook/v1beta1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|



Summary
Review
Independent tech review: APPROVE (
868cc37).Gates
task lint:markdownmkdocs build --strictgo build ./...task verifytask linttask test:runtask helm:testtask vuln:check