Repository navigation
Commit 546281e
committed
docs: move the operator guides out of docs/ to where readers find them
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 <[email protected]>
Signed-off-by: Myasnikov Daniil <[email protected]>1 parent 516be4a commit 546281e
26 files changed
Lines changed: 69 additions & 1342 deletions
File tree
- api/apps/v1alpha1/kubernetes
- docs
- changelogs
- hack
- e2e-apps
- e2e-chainsaw/kubernetes-oidc-system
- packages
- apps/kubernetes
- templates
- core/platform
- templates/bundles
- extra/monitoring
- system
- kubernetes-rd/cozyrds
- monitoring-rd/cozyrds
- monitoring/templates/grafana
- multus
- images/multus-cni
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
184 | 184 | | |
185 | 185 | | |
186 | 186 | | |
187 | | - | |
| 187 | + | |
188 | 188 | | |
189 | 189 | | |
190 | 190 | | |
| |||
580 | 580 | | |
581 | 581 | | |
582 | 582 | | |
583 | | - | |
| 583 | + | |
584 | 584 | | |
585 | 585 | | |
586 | 586 | | |
| |||
This file was deleted.
This file was deleted.
0 commit comments