search

plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
453 stars 613 forks source link

Deprecate "project" configuration in Volto (`src/config.js`) #6396

Open sneridagh opened 3 days ago

sneridagh commented 3 days ago

PLIP (Plone Improvement Proposal)

Responsible Persons

Proposer: Víctor Fernández de Alba (@sneridagh)

Seconder: Tiberiu Ichim (@tiberiuichim)

Abstract

The old fashioned "project layout" is discouraged, in favor of the "policy add-on package". There's nothing that limits to move all the config from a project to an add-on package.

Motivation

Duplication of concerns, unification of the developer experience. This will encourage also to move the project's logic to the policy add-on as well and keep the boilerplate empty and expendable. This will help upgrades in case that the boilerplate has to change, the integrators will have to move the policy add-on to the new boilerplate.

Proposal & Implementation

The configuration has been kept in Cookieplone for backwards compatibility, but it will be removed in Volto 19. So Volto 19 won't load it anymore.

Deliverables

Volto won't load the project config anymore.

Risks

No risks, this is a new convention, people will have to move the configuration to an add-on which is mostly copy/paste operation and fix the imports.

Participants

Víctor Fernández de Alba

stevepiercy commented 3 days ago

Would documentation of the new way of doing things be a deliverable for this PLIP? I'm not sure whether it is covered elsewhere.