Repository navigation
docs: move the guides that only live in the cozystack repo onto the site - #763
Merged
Merged
Conversation
myasnikovdaniil
requested review from
Andrei Kvapil (kvaps),
Timofei Larkin (lllamnyp) and
Timur Tukaev (tym83)
as code owners
October 21, 2026 10:53
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
1 task done
myasnikovdaniil
force-pushed
the
docs/move-remaining-guides
branch
from
October 29, 2026 10:37
3ef5851 to
95c2c0e
Compare
IvanHunters
approved these changes
Oct 30, 2026
IvanHunters
left a comment
IvanHunters
left a comment
Contributor
There was a problem hiding this comment.
LGTM on the content. Two operational notes below.
I diffed each moved page against its source under docs/ on cozystack main (ba0b1ac6e). The five guides are byte-for-byte copies apart from two expected transforms: the H1 is dropped in favor of the Hugo front matter, and the one repo-relative link in gateway-classes.md (../packages/extra/gateway/README.md) is rewritten to an absolute GitHub URL. No other relative links survive in the moved pages, so nothing breaks on the site.
The two edited pages check out too. In resource-management, MIGRATION_DRY_RUN=1 and the best-effort behaviour match migrations/39. In backup-classes, the Valkey row maps to cozy-default-redis through a kind: Redis strategyRef in backupclass-default.yaml, and the strategy-CR-waits-for-its-CRD paragraph matches the controller.
No file overlap with #782: this PR owns the next/ and v1.6/ copies, #782 owns v1.7/.
Notes:
- The branch is behind main and needs a rebase before it can merge.
- resource-management drops the only pointer to docs/operations/resource-presets.md, which still exists on main. If that is deliberate (syncing with the source page) then fine, otherwise the reference is worth keeping.
Guides kept landing in docs/ of the cozystack repository, where no operator looks, and the copies that did reach the site drifted from their originals: Backup Classes lacked the Valkey row and still said a pin was removed by "this PR". Add the five guides the site has no page for, and carry the repository edits over to Backup Classes and Resource Management, which have one. The originals are deleted in cozystack/cozystack once this lands, so nothing is left to drift. The pages go into next/ because the features they describe are in release-1.7 and not in release-1.6. storageClass immutability is the exception: release-1.6 already ships it, so its page is added to v1.6/ as well, from the release-1.6 text. Assisted-by: LLM Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
myasnikovdaniil
force-pushed
the
docs/move-remaining-guides
branch
from
October 30, 2026 10:41
95c2c0e to
1ea88e9
Compare
myasnikovdaniil
added a commit
that referenced
this pull request
Oct 30, 2026
The v1.7 docs were cut from next/ before #763 landed, so the released version and the stable /docs/ copy lack the five guides it moves onto the site, and its edits to the backup classes and resource management pages. All of it holds for v1.7.0: each new page is the copy of a file the v1.7.0 tag ships under docs/, and the values, flags, annotations, conditions and alerts the pages are built on are in the code at that tag. The Valkey binding, the Strategy CR wait for its CRD and the migration 39 dry-run note are in the tag as well. The pages are #763's next/ files with the rewrite release_next.sh applies. next/ stays with #763. Assisted-By: LLM Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
Contributor
Author
|
Resource presets must be available here https://cozystack.io/docs/guides/resource-management/#using-resource-presets |
myasnikovdaniil
added a commit
that referenced
this pull request
Oct 30, 2026
The v1.7 docs were cut from next/ before #763 landed, so the released version and the stable /docs/ copy lack the five guides it moves onto the site, and its edits to the backup classes and resource management pages. All of it holds for v1.7.0: each new page is the copy of a file the v1.7.0 tag ships under docs/, and the values, flags, annotations, conditions and alerts the pages are built on are in the code at that tag. The Valkey binding, the Strategy CR wait for its CRD and the migration 39 dry-run note are in the tag as well. The pages are #763's next/ files with the rewrite release_next.sh applies. next/ stays with #763. Assisted-By: LLM Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
myasnikovdaniil
added a commit
that referenced
this pull request
Oct 30, 2026
) The v1.7 docs were cut from `next/` in #780 while several docs PRs about v1.7.0 behaviour were still open against `next/` only, so `/docs/v1.7/` and the stable `/docs/` copy miss them. This adds their content to `content/en/docs/v1.7/`, checked against the v1.7.0 tag. Every page is the source PR's `next/` file with the same `/docs/next/` rewrite that `hack/release_next.sh` does, except where noted. - #763 - #747, hand-merged after `networking.kubeovn.MASTER_NODES` because main got the `networking.encryption.enabled` row after its base - #761, with four corrections below - #762 - #766 - #764, the HTTPCache section of the upgrade guide, in both `next/` and `v1.7/` on top of the fixes from #781. I'm not carrying 764 further, this PR takes over its content. Four lines of the Proxmox page are wrong for v1.7.0 and are fixed in the v1.7 copy only. `replicas: 2` in the KubernetesNodes example is now `minReplicas: 2` and `maxReplicas: 2`, there is no `replicas` field. The CCM and CSI controller Deployments are `kubernetes-<cluster>-pccm` and `kubernetes-<cluster>-pcsi-controller`. `bundles.enabledPackages` is set on the `cozystack.cozystack-platform` Package, no ConfigMap feeds it. The CSI release depends only on the tenant Cilium release, not on the CCM, so I cut that clause. The `next/` copy in 761 needs the same fixes. The `next/` side of 763, 747, 761, 762 and 766 and the `v1.6/` side of 763, 762 and 766 stay in their own PRs, so they still merge without conflicts with this one. Nothing generated is committed, the stable `/docs/` copies are built from `v1.7/` at build time. Hugo production and preview builds, `hack/check-i18n.sh` and a link and anchor check of every changed page pass locally, with the same Hugo warnings as main.
myasnikovdaniil
added a commit
to cozystack/cozystack
that referenced
this pull request
Nov 3, 2026
## What this PR does Seven guides under `docs/` were operator facing and written alongside 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/operations/backup-classes.md -> operations/services/backup-classes docs/operations/resource-presets.md -> guides/resource-management docs/storage-immutability.md -> operations/storage-class-immutability docs/operations/system-memory-limits.md -> operations/configuration/system-memory-limits docs/gateway-classes.md -> networking/gateway-classes docs/observability/distributed-tracing.md -> operations/services/monitoring/distributed-tracing docs/operations/seaweedfs-capacity-for-backups.md -> operations/services/object-storage/capacity-for-backups ``` `docs/release.md`, `docs/deprecating-applications.md` and the two SeaweedFS runbooks in `docs/operations/` stay. A workflow, `AGENTS.md`, a migration and a bats suite read them by path, which is the test from #3777. References point at `https://cozystack.io/docs/v1/...`. The site rewrites that short prefix to the latest version in `layouts/404.html`, so the links follow releases and pin none. Backup Classes, resource management and `storageClass` immutability exist in the latest version already. The other four pages are only in `next/` until 1.7.0 is promoted, and their links start to resolve then. The generated mongodb files come from `values.yaml` through `make generate` with cozyvalues-gen v1.7.0, the version pinned in `.github/workflows/pre-commit.yml`. Tests: helm unit tests for mongodb (151), postgres (209), vm-disk (114) and kubernetes-nodes (223), go tests for backupcontroller, presets and the operator, rd-presets-check, the migration-50 bats suite. ### Downstream repositories - [x] [cozystack/website](https://github.com/cozystack/website) - follow-up: cozystack/website#763 Walked the rest of the trigger map against the diff. No provider follow-up: the mongodb `values.schema.json` diff is one `description` string, with no field added, removed or renamed, no enum, no default, and no `kind`, `plural` or `release.prefix` change. `packages/core/platform/values.yaml` changed in comments only and no key, so the hand written platform-package table on the site is unaffected. Please merge after cozystack/website#763, the links in the code only resolve once those pages deploy. ### Release note ```release-note docs: seven guides move from the docs/ directory of this repository to cozystack.io (Backup Classes, resource presets, storageClass immutability, system component memory limits, GatewayClass selection, distributed tracing, SeaweedFS capacity for backups), and in-repo references point there. ```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Five guides that only lived in
docs/of the cozystack repo get pages here: distributed tracing, SeaweedFS capacity for backups, GatewayClass selection, system component memory limits andstorageClassimmutability. Four arenext/only, they are in release-1.7 and not in release-1.6. ThestorageClassone is also added tov1.6/, release-1.6 already ships it.Backup Classes and Resource Management had pages already, so I carried over what drifted since the import: the Valkey row and paragraph, strategy CRs waiting for their CRD, the "which this PR removes" leftover,
MIGRATION_DRY_RUN. Wording on the site that was already better stays, likeusers.<name>.password.cozystack/cozystack deletes the originals after this lands.