docs: move the operator guides out of docs/ to where readers find them - #3780
docs: move the operator guides out of docs/ to where readers find them#3780myasnikovdaniil wants to merge 1 commit into
Conversation
Five documents in docs/ were operator-facing guides written alongside
the feature PRs that added the code, and left in the source tree where
no user looks. They now live on the website (cozystack/website), so
delete them here and repoint every reference.
Moved to the website:
docs/oidc-tenant.md -> kubernetes/oidc-authentication
docs/oidc-grafana.md -> operations/services/monitoring/oidc-authentication
docs/gpu-vgpu.md -> virtualization/vgpu
+ operations/troubleshooting/gpu-operator-host-driver
docs/vm-external-vlan.md -> networking/vm-external-vlan
docs/hubble-observability.md -> networking/hubble
docs/vm-external-vlan.md needed splitting rather than moving. Its
"Staging the reference CNI plugins" section is a contract:
hack/cni-plugins-staging-contract.bats greps six literal sentences out
of it and asserts them against the multus Dockerfile, the daemonset
manifest and the platform values. That half is package documentation, so
it moves verbatim into a new packages/system/multus/README.md and the
suite reads it there; the operator guide goes to the website. The bats
messages now name the README, so a future failure points at the file
that has to change.
References repointed to https://cozystack.io/docs/v1.6/... in nine
hand-maintained files (two values.yaml @PARAM blocks, four template
comments, three test comments). The seven generated files -- both
values.schema.json, both README.md, the kubernetes Go types and both
cozyrds -- come from `make generate` with cozyvalues-gen v1.6.0, the
version pinned in .github/workflows/pre-commit.yml; each changed exactly
one line.
Two changelog links in v1.6.0.md repointed as well. The wording is
untouched: only the location of the documents it names has changed.
Two pieces of process framing dropped on the way past, per the
convention added in docs/agents/overview.md: system.yaml said GrafanaAdmin
promotion was "out of scope for Phase 1" (it is simply not implemented),
and the chainsaw suite pointed at "docs/oidc-tenant.md -> Phase 1".
Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (26)
💤 Files with no reviewable changes (5)
📝 WalkthroughWalkthroughThe change removes obsolete repository guides, adds Multus operational documentation, and updates OIDC, GPU/vGPU, and VLAN references to published or package-local documentation. ChangesDocumentation migration
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Trivy (0.72.0)Trivy execution failed: 2026-08-12T14:43:52Z FATAL Fatal error run error: fs scan error: scan error: scan failed: failed analysis: post analysis error: post analysis error: ansible scan error: fs filter error: fs filter error: walk error range error: stat api/apps/v1alpha1/.golangci.yml: no such file or directory: range error: stat api/apps/v1alpha1/.golangci.yml: no such file or directory 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 |
What this PR does
Five documents under
docs/were operator facing guides written alongside the feature PRs that added the code, and left in the source tree where no user looks. They are on the website now, so this deletes them here and repoints every reference.docs/vm-external-vlan.mdneeded splitting, not moving. Its "Staging the reference CNI plugins" section is a contract,hack/cni-plugins-staging-contract.batsgreps six literal sentences out of it and asserts them against the multus Dockerfile, the daemonset manifest and the platform values. That half is package documentation so it moves verbatim into a newpackages/system/multus/README.mdand the suite reads it there, the operator guide goes to the website. The bats messages name the README now, so a future failure points at the file that has to change.References repointed in nine hand maintained files, two
@paramblocks, four template comments and three test comments. The seven generated files come frommake generatewith cozyvalues-gen v1.6.0, the version pinned in.github/workflows/pre-commit.yml, and each of them changed exactly one line.Two changelog links in
docs/changelogs/v1.6.0.mdrepointed as well. The wording is untouched, only the location of the documents it names has changed.Two bits of process framing dropped on the way past, per #3777:
bundles/system.yamlsaid GrafanaAdmin promotion was "out of scope for Phase 1" when it is simply not implemented, and the chainsaw suite pointed at "docs/oidc-tenant.md -> Phase 1".Tests: 10 cni-plugins contract, 205 kubernetes chart, 11 multus chart, 9 monitoring chart, md-no-hardwrap.
Downstream repositories
Walked the rest of the trigger map against the diff. No provider follow-up: both
values.schema.jsondiffs are onedescriptionstring each, with no field added, removed or renamed, no enum, no default, and nokind,pluralorrelease.prefixchange.packages/core/platform/values.yamlchanged in a comment only and no key, so the hand written platform-package table on the site is unaffected.Please merge after the website PRs, the
@paramURLs only resolve once those pages deploy.Release note
Summary by CodeRabbit