Series of scripts to make migration to compose v2 easier.
This migration scripts focus only on content model and entries, be aware that if your Contentful implementation use Tags for your Compose:Page, this Tags need to be assigned to the new pages that will become main or root on your compose view.
Required contentful-management.js
Rename the config.template.js to config.js and setup the corresponding, spaceID, environmentID and CMA token.
/**
* 1.- Set your credentials on config.js
*/
exports.config = function () {
return {
spaceID: "YOUR_SPACE_ID_HERE",
envID: "YOUR_ENVIRONMENT_ID_HERE",
accessToken: "YOUR_CMA_TOKEN_HERE",
};
};- On each file, Set up the correct contentTypesID to update, SEO, or compose:page ID (if needed).
"1-updateContentType.js"
/**
* 2.- Define your SEO ContentTypeId, default is former compose 'seo'
*/
const ComposeSeoTypeID = "seo"
/**
* 3.- Add compose root or start pages to update. except "compose:page"
*/
const cTypesToUpdate = ["page_help_center_article","page_landing"];"2-copycontent.js"
/**
* 2.- Set former compose contentType Id, from where the fields Title,Slug and Seo will be copied.
*/
const ComposePageID = "page";
/**
* 3.- Set new compose root or start contentType Id, to where the fields Title,Slug and Seo (from former compose) will be copied.
*/
const ComposePagesTypeToUpdate = ["page_help_center_article", "page_landing"];"3-disableComposeV1.js"
/**
* 2.- Set former compose contentType Id, from where the fields Title,Slug and Seo will be copied.
*/
const composePageID = "page";note: if you are in a hurry to migrate perhaps a "quick and dirty" migration will help you as a start. jump to this section
$ node 1-updateContentType.js
...
$ node 2-copycontent.js
...
$ node 3-disableComposeV1.jsThe migration to composeV2 follows the DB pattern of expand&contract adjusted to content models, where fields are added, content is copied and the old fields are disabled.
Former 'compose:page' fields Title, Slug, and Seo need to be copied to each one of the new compose pages.
Besides adding the new fields, each new 'root' or 'start' compose v2 page, needs to be set up as a root page and the reference fields set up as composable entries (flat view on compose UX). For that we assign:
-
Assign the Contentful:AggregateRoot annotation to the content type itself
-
Assign the Contentful:AggregateComponent annotation to the reference field sections
more information here
Former 'compose:page' content for fields Title, Slug, and Seo needs to be copied to each one of the new compose pages entries. These new compose page entries are found by looking at the 'compose:page' field 'content', each reference entry under 'content' will become a 'root' or 'start' entry on compose V2.
Once new pages are marked as root, the legacy 'compose:page' content type is no longer required, we can now archive and later remove 'compose:page' entries and content Type.
For a detailed explanation and descriptions on steps, consult Contentful guide
I recommend doing this "quick and dirty" migration if you are in a hurry to change to compose version V2, or as a first step and temporary solution while proper migrations are scheduled, scoped and evaluated.
This migrations focus on make "landing pages" or "compose pages" content types as compose root/start pages, and add the original "compose:page" content type as a reference entry, in this way no frontend changes are needed and the editorial team will still be able to keep working on compose.
navigate to subfolder "quickAdirty"
$ cd quickAdirty
$ node 1.- addComposeField.js
...
$ node 2.- addComposeReference.js
...This script will set up the selected landing pages as "Contentful:AggregateRoot", making them visible in compose v2 as the root pages. Also, a new field will be added per landing page, this new field is a reference field to a "compose:page" entry and will be marked as "Contentful:AggregateComponent"
/**
* 2.- Add compose root or start pages to update. except "compose:page"
*/
const cTypesToUpdate = ["page_help_center_article", "landingpage"];
const ComposePageID = "page";This script will, for each landing page, add a reference to the corresponding "compose:page" entry, a bottom-top reference. this will make the original "compose:page" entry fields visible as a flat composable component in the compose v2 editor.
/**
* 2.- Add compose root or start pages to update. except "compose:page"
*/
const cTypesToUpdate = ["page_help_center_article"];
const ComposePageID = "page";Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
- The migrated pages will lose their assigned tags, that's because in the legacy content model the tags will be assigned to the entry of type Compose: Page and after the migration, this will just be a reference on the page (Compose PAGE fields), so the page loses the tags.
- Compose PAGE fields entry must be manually added for each newly created page (extra manual work)
- If you run the quick and dirty script on a single page type, the other page types will be removed (not deleted) from compose (it could be worth telling the client that, so if they want to use your script they have to migrate all of the page types)
- moving the tags from entry to another one could change the result of some queries or views so when you search instead of getting a compose page entry you might get a Compose PAGE fields entry (if you searched by tags)