Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Commit

Permalink
Release 4.0.0 - Upgrade steps
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Sep 21, 2021
1 parent e7d4b3b commit 1980cad
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,6 @@ issues, the API starts to stabilize and we've already started several addons
based on it: https://github.com/eea/volto-slate-metadata-mentions/ and
https://github.com/eea/volto-slate-zotero

## Upgrades

### Upgrade to 3.x.x

* Removed all deprecated, already in Volto Core, `futurevolto` components:
* `SidebarPopup`
* `ObjectWidget`
* `ObjectBrowserWidget`
* `helpers/Blocks`
* Table `inline button` and `copy&paste` support is not installed by default anymore.
You'll need to explicitly import the `tableButton` profile like:
* `volto:asDefault,tableButton`
* `volto-slate:minimalDefault,simpleLink,tableButton`

## Why

Some of the main reasons that drove us to create volto-slate instead of
Expand All @@ -56,6 +42,27 @@ enhancing Volto's draftjs implementation:
final rendered output is very clean. Note: The Slate editor value is a JSON
object, similar to the Draftjs based implementation.

## Upgrades

### Upgrade to 4.x.x

* Namespace the plugins [#156](https://github.com/eea/volto-slate/pull/156):
* Make sure you upgrade your slate plugins to use the new slate namespaced plugin ids.
See for example `volto-slate-footnote` [#23](https://github.com/eea/volto-slate-footnote/pull/23/commits/efdc07041097a6edf608b377141fba15fbee65cf)


### Upgrade to 3.x.x

* Removed all deprecated, already in Volto Core, `futurevolto` components:
* `SidebarPopup`
* `ObjectWidget`
* `ObjectBrowserWidget`
* `helpers/Blocks`
* Table `inline button` and `copy&paste` support is not installed by default anymore.
You'll need to explicitly import the `tableButton` profile like:
* `volto:asDefault,tableButton`
* `volto-slate:minimalDefault,simpleLink,tableButton`

## Available profiles.

volto-slate provides several optional configuration:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "volto-slate",
"version": "3.1.1",
"version": "4.0.0",
"description": "Slate.js integration with Volto",
"main": "src/index.js",
"author": "European Environment Agency: IDM2 A-Team",
Expand Down

0 comments on commit 1980cad

Please sign in to comment.