[WIP] Update 2.5 migration guide

[andrerom]

Question	Answer
JIRA Ticket
Versions	1.7/1.13/2.5

Update migration guide to reflect eZ Platform 2.5 and Legacy bridge 2.1 changes/improvements.

TODO:

• Do we have to cover WebpackEncore here? or can we link to another doc covering this change?
• A change here for applying DB changes depends on EZP-31735: As a Developer I'd like direct upgrade path from 1.13LTS to 2.5LTS ezsystems/ezpublish-kernel#3048
  • Also mentioned ´dbupdate-7.1.0-to-7.2.0-dfs.sql´ as mentioned here.
• Tech review (and possible testing) by @vidarl and/or QA

[andrerom]

The work here is blocked by the fact that flow migration can't be done on 1.13LTS or better yet 2.5LTS.

Making migration tools needed work on 2.5 will greatly simplify the doc here AND importantly the amount of work involved in migrating sites for partners.

[andrerom]

Closing as impossible right now. This is beyond what Support/PS can do as they where not involved in making the field types involved here, so they don't know the details on intended behaviour.

We need the following from product team, in order to be able to provide proper migration docs for 2.5 and 3.x:

• flow migration: support for direct migration to 2.5 and 3.x
• landing page migration: support for direct migration to 2.5* and 3.x
• XmlText migration: support for direct migration to 2.5 and 3.x (This is kind of done, as alongosz is taking maintenance ownership over this also for 3.0 now)

/cc @SylvainGuittard @lserwatka @bdunogier

* 2.5 Partly done by VL in doc, as doc is mentioning it's missing support for some block types that where added to Page Builder after 2.2.0.

[vidarl]

This is not the only thing needed.

I think we should just instruct user to run all upgrade things mentioned at https://doc.ezplatform.com/en/latest/updating/4_update_database/, but skip LandingPage -> Page builder upgrade mentioned for 2.2

Then continue here afterwards

[andrerom]

So I'm trying to provide a fast pass here as many steps there are not relevant when coming directly from 5.4.

We might be missing instructions for creating form container thought: https://doc.ezplatform.com/en/latest/updating/4_update_2.3/#form-builder

Can add that in 3.2.3 Add other eZ Enterprise schemas (eZ Enterprise only)

[vidarl]

But why should you skip all of that?
You for sure need to upgrade db schema to 2.5 ( or no migration scripts will run at all). But you should for instance also create new section for "Forms" (2.4) etc. and everything else explained there in order to get a fully functional 2.5.

[andrerom]

You for sure need to upgrade db schema to 2.5 ( or no migration scripts will run at all)

There is:

MySQL/MariaDB:
- `<new-ez-root>/vendor/ezsystems/ezpublish-kernel/data/update/mysql/dbupdate-5.4.0-to-6.13.0.sql`
- `<new-ez-root>/vendor/ezsystems/ezpublish-kernel/data/update/mysql/dbupdate-6.13.0-to-7.5.7.sql`

But you should for instance also create new section for "Forms" (2.4) etc. and everything else explained there in order to get a fully functional 2.5.

Yes I'm missing that one, as mentioned above, there is also a few other things we should cover.

Otherwise I think I cover everything else relevant when coming from 5.4, so to go true all of it then:

• KO: <1.7 Changes to Solr Bundle => AFAIK invalid, there are more changes to schema from 5.4 to 2.5
  • So we should add own section here on using the new solr schema instead
• OK: <1.13 Changes to permissions => Covered by dbupdate-5.4.0-to-6.13.0.sql AFAIK
• OK: <1.13 Changes to form-uploaded files => Irrelevant, is about LandingPage
• OK: <1.13 ezsearch_return_count table removal => This was covered in 5.4, could add it again if we want
• OK: <1.13 Increased password hash length => Should be covered by dbupdate-5.4.0-to-6.13.0.sql AFAIK
• OK: <2.2 Change from UTF8 to UTF8MB4 => Covered in the links here
• OK: <2.2 Page builder => Not relevant, we install the table clean with all fixes in step to install EE tables
• OK: <2.2 Migrate Landing Pages => Covered below here
• OK: <2.3 Changes to timestamp => Covered by the NEW (PR) dbupdate-6.13.0-to-7.5.7
• KO: <2.3 Form builder => We should add that step here or link to it, as described in comment above.
• OK: <2.4 Workflow => Covered by instructions to install all EE tables
• ??: <2.4 Changes to the Forms folder => Kind of assume command above to create folder uses right section, but worth checking
• OK: <2.4 Changes to Custom tags => Irrelevant, install does not yet use RichText

Then there is 2.5 page:

• OK: All DB steps are covered by dbupdate-6.13.0-to-7.5.7
• OK: DoctrineSchemaBundle is already enabled as we instruct people to use clean 2.5.x as starting point here
• OK: matrix steps is covered here
• ??: Cache flush can be relevant, even if not for the same reasons, so we should rather add section somewhere during the steps to clear cache here using symfony cache pool command
• OK: 2.5.3 page builder is covered in instructions here
• OK: 2.5.6 Password expiration should be covered by dbupdate-6.13.0-to-7.5.7

[vidarl]

My biggest concern with your proposal here is if there are new changes to 2.5 schema... Then we have to remember to add instructions here again about applying those after dbupdate-6.13.0-to-7.5.7.sql

Or, we instead have a dbupdate-6.13.0-to-7.5.0.sql and ask user to run all upgrade scripts for 2.5... ?

KO: <2.3 Form builder => We should add that step here or link to it, as described in comment above.
(...)
??: <2.4 Changes to the Forms folder => Kind of assume command above to create folder uses right section, but worth
checking

yes, so I think we either to cut&paste that doc to this migration doc, or link to it.

[andrerom]

My biggest concern with your proposal here is if there are new changes to 2.5 schema... Then we have to remember to add instructions here again about applying those after dbupdate-6.13.0-to-7.5.7.sql

No, this file only goes up to 7.5.7, intention is to ask user to check if there are further changes after that in update instructions.

Or, we instead have a dbupdate-6.13.0-to-7.5.0.sql and ask user to run all upgrade scripts for 2.5... ?

This is discussed here: ezsystems/ezpublish-kernel#3048

[vidarl]

Yeah, I saw that, and you ask yourself if it maybe should be a dbupdate-6.13.0-to-7.5.0.sql instead.

But OK, both ways works for me then

[andrerom]

Same here, directly to 7.5.7 simplifies things here given we anyway update this now, however it might be confusing as it breaks former conventions. I'll probably adapt it here and there to change it.

UPDATE: The sql files have been updated to be from 6.13.0 to 7.5.0, besides the KO items in list above there now needs to be instructions about following update steps at the end here I think. Can be aligned with how 3.0 upgrade doc is doing this most likely.

[andrerom]

@vidarl Pushed changes now, I dropped the Reactor part as I could not get it to run / install without issues.

For further suggestion, could you take over and contribute to this perhaps?