Skip to content

Docs: Add deprecation warning for src/config.js (Volto 18+) #7756

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

Open
gummybearansh wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Docs: Add deprecation warning for src/config.js (Volto 18+) #7756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
225f264
Docs: Update configuration how-to with Volto 18 deprecation warning
gummybearansh Dec 29, 2025
f15c12c
fix: corrected notice for older projects
gummybearansh Dec 29, 2025
00ec141
fix: proper MyST directives
gummybearansh Dec 30, 2025
5c9d3c5
Added: Change log entry
gummybearansh Dec 30, 2025
25a2478
Update packages/volto/news/7756.documentation
gummybearansh Dec 31, 2025
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
10 changes: 7 additions & 3 deletions docs/source/configuration/how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,15 @@ a pipe would be:

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.
add-ons, it must be provided in the main {file}`index.js` module of the add-on.

See the {doc}`../conceptual-guides/add-ons` and {doc}`../development/add-ons/index` sections for extended information on how to work with add-ons.
```{versiondeprecated} Volto 18

As of Volto 18, the project configuration approach using {file}`src/config.js` is deprecated and will be removed in Volto 19.
New projects created with Cookieplone now use a {file}`config/` folder approach.
```

See the {doc}`../conceptual-guides/add-ons` and {doc}`../development/add-ons/index` sections for extended information on how to work with add-ons.

## Extending configuration in a project

Expand Down
1 change: 1 addition & 0 deletions packages/volto/news/7756.documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update configuration documentation to reflect that {file}`src/config.js` is deprecated in Volto 18+ in favor of the {file}`config/` folder structure. @gummybearansh