Installation and upgrades

Installation

1. Install it and enable the Gutenberg Drupal module.
2. Add the desired user roles to the "Gutenberg Blocks" text format.
3. Assign the "Use Gutenberg experience" permission to the desired user roles.
4. At any content type edit page, enable Gutenberg:

See the 1 minute tutorial video on how to install

If there are other text fields (or any other custom field), those will appear at editor's More Settings after the content section:

Gutenberg and security

The Gutenberg editor depends on a full featured HTML set to make it "an experience" for the content creators. Although the Gutenberg JS library is quite restrictive in allowing only a specific markup for individual blocks, the Gutenberg text format by default does not limit or clean the submitted markup and therefore behaves similar Drupal Core's "Full HTML" text format.

You should ensure to only allow trustworthy user roles to use the Gutenberg text format and "Use Gutenberg experience" permission. Enabling those for non-trustworthy user roles or anonymous users can lead to an unsafe site.

Applying Gutenberg to existing content

Gutenberg is easy to install on a brand new content type. But when you try to use it on a content type that already has content with markup from another editor you will probably face some challenges.

In the WordPress world this switch from the old editor to Gutenberg, triggers a PHP process native to WordPress that updates the content markup to work with Gutenberg. So if you need to do something similar, that could be a place to check. Currently (September 2021) we haven't tried to port this to Drupal Gutenberg. Reach out in the issue queue if you want to start that work and needs someone to chime in.

How to upgrade Drupal Gutenberg

The module is updated like any other Drupal module. We recommend using Composer:

$ composer require drupal/gutenberg

You need to clear cache after an update, even though cache is turned off. This is because Drupal always saves some module data/configuration in cache.

Updating the Drupal Gutenberg module will not automatically update your cloud blocks. They can be updated and tested one by one separately.