Skip to content

Conversation

@gummybearansh
Copy link

@gummybearansh gummybearansh commented Dec 29, 2025

Description

Updates the configuration registry documentation to reflect that the project configuration approach using src/config.js is deprecated in Volto 18+ in favor of the config/ folder structure.

Related Issue

Closes #7601

Changes

  • Added a {warning} block to docs/source/configuration/how-to.md regarding the deprecation.
  • Added a link to the Volto Customization training for the new config/ approach.
  • Clarified that src/config.js is still valid for older projects.

📚 Documentation preview 📚: https://volto--7756.org.readthedocs.build/

@boring-cyborg
Copy link

boring-cyborg bot commented Dec 29, 2025

Caution

The Volto Team has suspended its review of new pull requests from first-time contributors until the release of Plone 7, which is preliminarily scheduled for the second quarter of 2026.
Read details.

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read
Plone's Code of Conduct,
Contributing to Plone,
First-time contributors, and
Contributing to Volto,
as this will greatly help the review process.

Welcome to the Plone community! 🎉

@mister-roboto
Copy link

@gummybearansh you need to sign the Plone Contributor Agreement to merge this pull request.

Learn about the Plone Contributor Agreement: https://plone.org/foundation/contributors-agreement

If you have already signed the agreement, please allow a week for your agreement to be processed.
Once it is processed, you will receive an email invitation to join the plone GitHub organization as a Contributor.

If after a week you have not received an invitation, then please contact agreements@plone.org.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! I've made some suggestions.

@mister-roboto
Copy link

@gummybearansh you need to sign the Plone Contributor Agreement to merge this pull request.

Learn about the Plone Contributor Agreement: https://plone.org/foundation/contributors-agreement

If you have already signed the agreement, please allow a week for your agreement to be processed.
Once it is processed, you will receive an email invitation to join the plone GitHub organization as a Contributor.

If after a week you have not received an invitation, then please contact agreements@plone.org.

@gummybearansh
Copy link
Author

Thanks for your contribution! I've made some suggestions.

Thanks for the detailed review and the guidance on MyST directives!

I have updated the file to:

  1. Revert the accidental header formatting.

  2. Use the {versiondeprecated} and {file} directives as requested.

  3. Remove the external link to the training materials to keep the docs as the source of truth.

I will open a separate PR shortly to add the .vscode/settings.json file as you suggested.

Ready for another look when you have a moment.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I want a technical review from the Volto Team before it's merged.

Also before merging, we need your permission to publish your work. See https://6.docs.plone.org/contributing/#sign-and-return-the-plone-contributor-agreement.

@github-project-automation github-project-automation bot moved this from In Progress to Approved in Plone Documentation Dec 30, 2025
@stevepiercy
Copy link
Collaborator

Also it needs a change log entry per https://6.docs.plone.org/contributing/#change-log-entry

@mister-roboto
Copy link

@gummybearansh you need to sign the Plone Contributor Agreement to merge this pull request.

Learn about the Plone Contributor Agreement: https://plone.org/foundation/contributors-agreement

If you have already signed the agreement, please allow a week for your agreement to be processed.
Once it is processed, you will receive an email invitation to join the plone GitHub organization as a Contributor.

If after a week you have not received an invitation, then please contact agreements@plone.org.

@gummybearansh
Copy link
Author

I have already signed and submitted the form. I am currently waiting for the acceptance confirmation

I have added the changelog entry.

Standing by for Volto team technical reivew.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Approved

Development

Successfully merging this pull request may close these issues.

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

3 participants