Skip to content

docs(ops): add version management, compatibility matrix and release notes pages - #90

Merged
lzjqsdd merged 1 commit into
mainfrom
docs/version-management-compatibility
Aug 19, 2026
Merged

docs(ops): add version management, compatibility matrix and release notes pages#90
lzjqsdd merged 1 commit into
mainfrom
docs/version-management-compatibility

Conversation

@lzjqsdd

@lzjqsdd lzjqsdd commented Aug 18, 2026

Copy link
Copy Markdown
Member

Summary

Adds operational documentation for Curvine's version management and compatibility
features introduced in the 0.4.x series (structured component versions, worker
version reporting, diagnose/enforce compatibility policy).

Issue Describe / Design

Related to CurvineIO/curvine#1527 (component version
management) — sub-task T12 deliverables: compatibility matrix, known
incompatible versions, release notes template, CLI worker version statistics and
compatibility metrics documentation.

Changes

Module / File Change Impact on existing behavior
docs/3-User-Manuals/2-Operations/04-version-management.md + zh-cn New page: version schema, protocol version, --version-json, cv node --versions, compatibility matrix, diagnose/enforce policy, capabilities, compatibility metrics None (new page)
docs/3-User-Manuals/2-Operations/05-release-notes.md + zh-cn New page: release notes template and known incompatible versions list None (new page)
docs/3-User-Manuals/2-Operations/02-cli.md + zh-cn Document cv node --versions and global --version-json None (doc only)
docs/3-User-Manuals/2-Operations/03-monitoring.md + zh-cn Document compat_worker_verdict, compat_client_verdict, compat_enforce_rejected_total metrics None (doc only)

Test verified

Test case Result Notes
yarn build (EN + zh-cn locales, broken-link check) PASS Docusaurus 3.8.0

Dependencies

…otes pages

- add Operations 'Version Management and Compatibility' page (EN + zh-cn):
  version schema, protocol version, component version JSON, worker version
  distribution via 'cv node --versions', compatibility matrix for
  master/worker/client, diagnose/enforce policy, capabilities and
  compatibility metrics.
- add Operations 'Release Notes and Known Incompatible Versions' page
  (EN + zh-cn): release notes template and known-bad version list.
- document 'cv node --versions' and global --version-json in the CLI guide.
- document compat_worker_verdict / compat_client_verdict /
  compat_enforce_rejected_total in the monitoring page.
@lzjqsdd
lzjqsdd marked this pull request as ready for review August 19, 2026 01:46
@lzjqsdd
lzjqsdd merged commit fbf0ec5 into main Aug 19, 2026
2 checks passed
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.

1 participant