Project

General

Profile

Actions
Copy link

Task #3335

open

Improve migration guide and changelog

Added by Peter Štrunc about 1 year ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Release
Target version:
13.1.0
Start date:
04/17/2023
Due date:
% Done:

0%

Estimated time:
Owner:

Description

We received some feedback regarding the upgrade process, particularly about CHANGELOG.md and MIGRATION.md. Some issues we gathered are:

  • Required migration steps are not in one place (some steps are in the changelog, some in migration)
  • Sometimes it is ambiguous, what should admin, or developer do and in what order

Having that in mind, we should improve on these issues and make the process more understandable, while keeping the idea of a changelog file being a list of changes and migration a step-by-step guide to more complex migrations.

No data to display

Actions
Copy link

Also available in: Atom PDF