Skip to main content

# Upgrade Path

The majority of changes are detailed in Github Release Notes, including most breaking changes. You should consult the release notes for each version you will be updating through/to.

Upgrade paths for specific version, detailed here, are reserved for:

- Required Upgrades
- In Depth Upgrades

Required Upgrade

Versions you must upgrade to before upgrading to a newer version. Likely due to the codebase containing functionality to upgrade persistent data that cannot be migrating across multiple versions.

Optional Upgrade

(Breaking) Changes to configuration/data that require more detail or formatting than is feasible in Github release notes. These upgrades may be skipped.

The type of upgrade is shown at the top of each page with the same colored callout shown above.