Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add upgrade docs for users of @kitconcept/volto-blocks-grid addon #5333

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Add upgrade docs for users of @kitconcept/volto-blocks-grid addon #5333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72fdf88
Add docs for users of `@kitconcept/volto-blocks-grid` addon
sneridagh Oct 23, 2023
8c7803c
Changelog
sneridagh Oct 23, 2023
67f3f68
Deduplicate content and add reference link to authoritative upgrade g…
stevepiercy Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions docs/source/blocks/core/grid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ myst:
# Grid block

```{versionadded} Volto 17.0.0-alpha.16
See {ref}`grid-block-migration-from-kitconcept-volto-blocks-grid-label`.
```

Volto comes with a grid block.
Expand Down Expand Up @@ -156,16 +157,3 @@ export const GridBlockDataAdapter = ({
onChangeBlock(block, dataSaved);
};
```


## Migration from `@kitconcept/volto-blocks-grid`

The grid block was added to Volto in version 17.0.0-alpha.16.
It is based on the `@kitconcept/volto-blocks-grid` add-on version 7.x.x.

The Volto core grid uses the Volto internals default blocks-in-block architecture.
This differs from the grid block data structure in the add-on `@kitconcept/volto-blocks-grid`.
Because of this difference, they are not compatible, and a data migration is necessary from the add-on to the Volto grid block.

However, the Volto core grid block uses a different internal name, `gridBlock`, so both blocks can coexist at the same time.
Nonetheless, it is recommended to enable only one grid block type for your users, and eventually use a single version to avoid unexpected behaviors and bugs.
31 changes: 31 additions & 0 deletions docs/source/upgrade-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,37 @@ It requires the latest version of `plone.restapi` (>=8.42.0) installed in the ba
The `utils.js` file of the Teaser block was removed because it is no longer used.
You can consider removing it if you were shadowing it in your project.

(grid-block-migration-from-kitconcept-volto-blocks-grid-label)=

### Grid block migration from `@kitconcept/volto-blocks-grid`

The grid block was added to Volto in version 17.0.0-alpha.16.
It is based on the `@kitconcept/volto-blocks-grid` add-on version 7.x.x.

If you previously used `@kitconcept/volto-blocks-grid` in your project based on a Volto version before 17.0.0-alpha.16, then your site will show two available block types both named `Grid`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sneridagh @davisagli can you verify this sentence for accuracy?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is accurate, then later it explains how to deal with that situation, by using restricted property.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging!

You need to disable one of them based on the following information.

The Volto core grid block uses the Volto default internal blocks-in-block architecture.
This differs from the grid block data structure in the add-on `@kitconcept/volto-blocks-grid`.
Because of this difference, they are not compatible, and a data migration is necessary from the add-on to the Volto grid block.
This migration is not yet available.

However, the Volto core grid block uses a different internal name, `gridBlock`, so both block types can coexist.
Nonetheless, it is recommended to enable only one grid block type for your users, and eventually use a single version to avoid unexpected behaviors and bugs.

You can disable the one you won't use with one of the following configuration settings.

```js
// This disables the `@kitconcept/volto-blocks-grid` grid block
config.blocks.blocksConfig.__grid.restricted = true;

// This disables the Volto core grid block
config.blocks.blocksConfig.gridBlock.restricted = true;
```

As long as you keep the add-on in place, your existing blocks will work as expected, even if you restrict the block.
We recommend that you disable the `@kitconcept/volto-blocks-grid` block and use the new Volto core grid block for new content.


(volto-upgrade-guide-16.x.x)=

Expand Down
1 change: 1 addition & 0 deletions news/5333.documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add upgrade docs for users of `@kitconcept/volto-blocks-grid` addon @sneridagh