From 16ffad6a65792fd2f8d39be44f47ad1e692359a2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 9 Mar 2024 13:17:05 -0500 Subject: [PATCH 1/2] Add reference to Docker installation for some Linux distributions (#5861) --- docs/source/contributing/install-docker.md | 5 +++++ packages/volto/news/5861.documentation | 1 + 2 files changed, 6 insertions(+) create mode 100644 packages/volto/news/5861.documentation diff --git a/docs/source/contributing/install-docker.md b/docs/source/contributing/install-docker.md index ee5a9e05e0..2902fa1b76 100644 --- a/docs/source/contributing/install-docker.md +++ b/docs/source/contributing/install-docker.md @@ -1,2 +1,7 @@ Install [Docker Desktop](https://docs.docker.com/get-docker/) for your operating system. Docker Desktop includes all Docker tools. + +```{note} +For some Linux distributions, you might need to create a group `docker` and add your user to this group. +See [Linux post-installation steps for Docker Engine](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for details. +``` \ No newline at end of file diff --git a/packages/volto/news/5861.documentation b/packages/volto/news/5861.documentation new file mode 100644 index 0000000000..b3dca3111c --- /dev/null +++ b/packages/volto/news/5861.documentation @@ -0,0 +1 @@ +Add reference to Docker installation for some Linux distributions. @stevepiercy From 03b30f9817d0883f27b82bf789f6a6225b1aaec3 Mon Sep 17 00:00:00 2001 From: David Glick Date: Sun, 10 Mar 2024 20:18:57 -0700 Subject: [PATCH 2/2] Update docs for defaultBlockType setting (#5862) Co-authored-by: Steve Piercy --- docs/source/blocks/settings.md | 9 ++++++--- docs/source/configuration/settings-reference.md | 5 +++-- packages/volto/news/5854.documentation | 1 + 3 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 packages/volto/news/5854.documentation diff --git a/docs/source/blocks/settings.md b/docs/source/blocks/settings.md index 7012d99883..0dcb406c45 100644 --- a/docs/source/blocks/settings.md +++ b/docs/source/blocks/settings.md @@ -142,13 +142,16 @@ Our new block should be ready to use in the editor. It is a common pattern to use the block configuration to allow customization of a block's behavior or to provide block-specific implementation of various Volto mechanisms. Some of these common options are described in the following sections. +(blockHasValue)= + ### `blockHasValue` -`blockHasValue` returns `true` if the provided block data represents a value for the current block. +`blockHasValue` is a function that returns `true` if the provided block data represents a non-empty value for the current block. Required for alternate default block types implementations. +It has the following signature. -```{seealso} -See also [Settings reference](../configuration/settings-reference). +```jsx +blockHasValue(data) => boolean ``` ### `initialValue` diff --git a/docs/source/configuration/settings-reference.md b/docs/source/configuration/settings-reference.md index afa7f85e46..87ba1afce2 100644 --- a/docs/source/configuration/settings-reference.md +++ b/docs/source/configuration/settings-reference.md @@ -26,8 +26,9 @@ navDepth Navigation levels depth used in the navigation endpoint calls. Increasing this is useful for implementing fat navigation menus. Defaults to `1`. defaultBlockType - The default block type in Volto is "text", which uses the current DraftJS-based implementation for the rich text editor. Future alternative rich text editors will need to use this setting and replace it with their block type. The block definition should also include the `blockHasValue` function, which is needed to activate the Block Chooser functionality. See this function signature in [Blocks > Settings](../blocks/settings.md). - + The name of the default block type used when a new block is added. + The default value of this setting is `slate`, which uses the current Slate-based implementation for the rich text editor. + If you change this to a different type of block, make sure the block configuration includes the {ref}`blockHasValue` function. sentryOptions In Volto 16.0.0.alpha.45, Sentry integration was moved from core to the add-on [`@plone-collective/volto-sentry`](https://www.npmjs.com/package/@plone-collective/volto-sentry). diff --git a/packages/volto/news/5854.documentation b/packages/volto/news/5854.documentation new file mode 100644 index 0000000000..97afa6e088 --- /dev/null +++ b/packages/volto/news/5854.documentation @@ -0,0 +1 @@ +Update docs for the `defaultBlockType` setting. @davisagli