Skip to content

Confusion on what config settings approach is useful on page /volto/configuration/how-to.html #7601

@acsr

Description

@acsr

This text on where to put the config settings seems outdated:

https://6.docs.plone.org/volto/configuration/how-to.html

The configuration registry

...
Both use the same method, using a function as the default export. This function takes a config and should return the config once you've ended your modifications. For add-ons, it must be provided in the main index.js module of the add-on. For project's it must be provided in the src/config.js module of the project.
see: https://github.com/plone/volto/blame/d3ba4782dda86bafe5430b0b085584cefed45b25/docs/source/configuration/how-to.md#L36

There is a related a deprecation warning in:
https://6.docs.plone.org/volto/conceptual-guides/add-ons.html#add-on-configuration-pipeline

Add-on configuration pipeline
A Volto app's configuration is determined through a pipeline starting with Volto's default configuration, then each of your app's add-ons' configuration. In Volto 17 and earlier, you can also use project configuration at the end of the pipeline after any add-ons.

Deprecated since version Volto: 18.0.0
The project configuration approach is deprecated and will be removed in Volto 19.

One new approach using the config/foldercreated by lates cookieplone setups is now mentioned in the recent trainings:
Volto Customization for JavaScript Beginners -> 3. Most useful Volto settings
https://training.plone.org/volto-customization/voltosettings.html

The old approach is in use and still working, but the new kid is around the block (haha we use blocks).
At least the new stuff should be mentioned and linked here.

Refining and strreamlining everything may take some more love.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions