Skip to content

docs: align docs with v1beta1-only API - #185

Merged
konih merged 1 commit into
mainfrom
fix/status-deck-doc-nits
Aug 4, 2026
Merged

docs: align docs with v1beta1-only API#185
konih merged 1 commit into
mainfrom
fix/status-deck-doc-nits

Conversation

@konih

@konih konih commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • remove stale v1alpha1 and conversion-webhook references after v0.15.0
  • align developer/runtime paths with the v1beta1-only layout
  • document the terminal authentication retry flag and stored-version migration condition

Review

Independent tech review: APPROVE (868cc37).

Gates

  • task lint:markdown
  • mkdocs build --strict
  • go build ./...
  • task verify
  • task lint
  • task test:run
  • task helm:test
  • task vuln:check

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.
Copilot AI lite review requested due to automatic review settings August 4, 2026 13:56
@konih

konih commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator Author

REVIEW — mkurator/status-deck-doc-nits @ 868cc37 — APPROVE — 2026-08-04

Verdict: APPROVE

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 v1alpha1 and the conversion webhook across key docs.
  • Align repository layout and webhook path documentation with api/v1beta1 and internal/webhook/v1beta1.
  • Document the --terminal-retry-interval runtime 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

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sonarqubecloud

sonarqubecloud Bot commented Aug 4, 2026

Copy link
Copy Markdown

@konih
konih merged commit 1d369a6 into main Aug 4, 2026
20 checks passed
@konih
konih deleted the fix/status-deck-doc-nits branch August 4, 2026 15:13
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.

2 participants