Provide an upgrade step from 1.x to 2.x

collective / collective.nitf

A Dexterity-based content type inspired on the News Industry Text Format specification

8 stars 3 forks source link

Provide an upgrade step from 1.x to 2.x #198

Closed hvelarde closed 7 years ago

hvelarde commented 7 years ago

We need to provide an upgrade step to migrate collective.nit from 1.x to 2.x in a sane way.

The upgrade step must:

[x] update control panel permissions (?)
[x] remove character counter static resources
[x] add collective.nitf resources
[x] fix collection filter for Urgency field (?)
[x] update behavior information
[x] update view methods information
[x] reindex all items on the catalog

hvelarde commented 7 years ago

FYI @idgserpro; we will need your help to test this at some point.

rodfersou commented 7 years ago

The main work here are about differences at default profile of both versions, and the differences are: 001 002 003 004 005 006 007 008 013 014

I think we should try to do all the upgrade step programmatically (needs to learn how to work with all tools envolved), this way we can add some tests.

Some views change name also, for c.nitf 1.x we have:

view
nitf_galleria

While for c.nitf 2.x we have:

view
slideshow_view
text_only_view

For controlpanel settings we have for 1.x: 010 011

And for 2.x: 012

hvelarde commented 7 years ago

migration path should be between profile versions 1008 and 2000.

idgserpro commented 7 years ago

Shouldn't you change in docs, from

You have to be aware of the following changes when migrating from version 1.x to 2.x:

You have to be aware of the following changes when migrating from version 1.x to 2.x (beware that you **need** to at least upgrade to > 2.1 since the the news portlet was removed):

Then you can go with https://github.com/collective/collective.nitf/pull/197#issuecomment-301888851.

Let me get this straight: you plan in closing the PR in https://github.com/collective/collective.nitf/pull/197, then just remove the portlet code presented 2.x, then create a simple upgradeStep that removes the portlet in 1.x? And add a note to README?

idgserpro commented 7 years ago

We think it's importante to complement with "you should upgrade to the last 1.x version before upgrading to 2.x". From 1.x to 2.x, at least in a semantic versioning definition, some api "breakage" is expected.

hvelarde commented 7 years ago

I'll prepare a couple of PR to address the portlet issue and we can discuss further there.