Skip to content

📚 Proposal: Add Upgrade/Migration Documentation Guide #510

@pratik-mahalle

Description

@pratik-mahalle

Reason/Context

Currently, there's no dedicated documentation page for users upgrading between Microcks versions. Upgrade information is scattered across release blog posts, and users—especially enterprise teams new to Microcks—may not know where to look or whether any action is required when upgrading.

Description

Create a new documentation page at /documentation/guides/administration/upgrading.md that consolidates upgrade guidance.

The page would explain Microcks’ versioning philosophy and compatibility expectations, outline a clear pre-upgrade checklist (backups, release note review, staging tests), and provide step-by-step upgrade instructions for Helm Chart, Kubernetes Operator, and Docker/Podman Compose deployments.

Placement rationale: /documentation/guides/administration/ is the natural home, alongside related admin topics like users, secrets, and snapshots.

Implementation ideas

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions