diff --git a/docs/source/_inc/_branch-policy.md b/docs/source/_inc/_branch-policy.md index 22046b8266..eaaf06903f 100644 --- a/docs/source/_inc/_branch-policy.md +++ b/docs/source/_inc/_branch-policy.md @@ -13,6 +13,13 @@ canary During the development process, a canary release will be cut from the `main` branch. When it becomes worthy of a beta or release candidate version, a new numbered branch should be cut, and non-breaking changes must be merged into it. +legacy +: The term _legacy_ refers to a version that is no longer supported or actively maintained. + They are the versions between official Plone minor releases. + You should update to minor Plone releases as soon as possible. + Legacy versions won't receive any new features. + They might receive occasional bug fixes or security updates, subject to approval from the Volto Team. + `main` : This is the bleeding edge branch in git. It is the branch upon which future development occurs, and from which future releases shall be cut. @@ -31,11 +38,19 @@ canary If the pull request is a feature or a bugfix, and if the release manager deems it useful to the latest version's branch, they may ask you to backport it to that branch. -`17.x.x` -: `17.x.x` is the current stable and actively developed branch in git. - Upon the final release of version `18.0.0`, the `17.x.x` branch line will be no longer supported. +`18.x.x` +: `18.x.x` is the current stable and actively developed branch in git. + This version of Volto has the [same maintenance and support schedule as Plone 6.1](https://plone.org/download/release-schedule). Any new feature will be merged into the `main` branch, and only backported to and released in older versions, if the Volto Team approves it. +`17.x.x` +: `17.x.x` is no longer supported and became _legacy_ (see above definition) when Volto 18 was released. + You should upgrade to the latest released version of Volto 18. + You can use Cookieplone to generate a new Volto 18 project, then copy-paste over the relevant parts from your existing project into the new one. + See {ref}`volto-upgrade-guide-18.x.x`. + If you need a bug fix, please create an issue to discuss with the Volto Team. + For security issues, please contact the Plone Security Team by sending email to security@plone.org. + `16.x.x` : This version of Volto has the [same maintenance and support schedule as Plone 6.0](https://plone.org/download/release-schedule). It receives bug fixes and security updates. diff --git a/docs/source/_inc/_semantic-ui-deprecation.md b/docs/source/_inc/_semantic-ui-deprecation.md new file mode 100644 index 0000000000..86a1b628a5 --- /dev/null +++ b/docs/source/_inc/_semantic-ui-deprecation.md @@ -0,0 +1,6 @@ +```{deprecated} Volto 18 +Semantic UI development and maintenance has been inconsistent since 2018. +The Volto Team made the decision to move forward in a sustainable direction. +Plone 7 will use a different theming approach, based on the [`@plone/components`](https://www.npmjs.com/package/@plone/components)—which in turn is based on [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html)—and [`@plone/theming`](https://github.com/plone/volto/tree/main/packages/theming) packages. +Using Semantic UI theming for your project or add-on is deprecated from Volto 18 onward, and will be removed in Plone 7. +``` diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index fe42d3d1d5..cb779f97be 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -16,14 +16,19 @@ This chapter describes the versions of software that Volto supports and how Volt (volto-generator-compatibility-with-volto-label)= -## `volto-generator` compatibility with Volto +## `@plone/volto-generator` compatibility with Volto -`volto-generator` is a tool that generates a Volto project. -The following table describes the compatibility between versions of `volto-generator` and Volto. +```{deprecated} Volto 18.0.0 +`@plone/volto-generator` was deprecated in Volto 18.0.0. +It is not maintained, and you should not use it. +For new projects, follow {doc}`plone:install/create-project-cookieplone` instead. +``` + +`@plone/volto-generator` is a tool that generates a Volto project. +The following table describes the compatibility between versions of `@plone/volto-generator` and Volto. | Generator version | Volto version | |-------------------|---------------| -| 9.x | 18.x.x | | 7.x and 8.x | 17.x.x | | 6.x | 16.x.x | @@ -40,10 +45,15 @@ We will always support the [latest major Plone release](https://plone.org/downlo The versions of Python that are supported in Volto depend on the version of Plone that you use. -| Plone | Python | Volto | -| ----- | ------------ | ------------ | -| 6.0 | 3.8-3.11 | 16.0 or 17.0 | -| 5.2 | 2.7, 3.6-3.8 | 15.0 | +| Plone | Python | Volto | +| ----- | ------------ | ---------------- | +| 6.1 | 3.10-3.13 | 18.0.0 | +| 6.0 | 3.9-3.13 | 16.0.0 or 17.0.0 | +| 5.2 | 2.7, 3.8 | 15.0.0 | + +For Plone 6.0.x, Python 3.12 is officially supported since Plone 6.0.10. +Python 3.13 is officially supported since 6.0.14. +Python 3.8 support was dropped in 6.0.14. On Plone 6, we recommend using the known good set (KGS) of package versions that are specified in the Plone release. @@ -72,8 +82,12 @@ Volto runs using [Node.js](https://nodejs.org/en). Volto supports only the latest two [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule). We recommend using the current LTS version. -- Node.js 22 LTS: Supported since Volto 18. -- Node.js 20 LTS: Supported since Volto 17. +| Node.js | Volto | +| ------- | ----------- | +| 20, 22 | Volto 18 | +| 18, 20 | Volto 17 | +| 16, 18 | Volto 16 | + - Node.js 18: No longer supported. It was supported in Volto 16 - 17. - Node.js 16: No longer supported. It was supported in Volto 14 - 16. - Node.js 14: No longer supported. It was supported in Volto 8.8.0 - 16. @@ -83,11 +97,10 @@ We recommend using the current LTS version. (version-policy-supported-browsers)= -## Supported browsers - -Volto works well with the current version of any modern browser—including Chrome, Firefox, Safari, and Edge—as well as their mobile flavors. +## Supported web browsers -We do not guarantee that outdated browsers, such as Internet Explorer 11, are supported by Volto. +```{include} ../../_inc/_install-browser-reqs-volto.md +``` ## Branch policy diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index b3aaf62767..9b23b64a5e 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -9,6 +9,9 @@ myst: # About Semantic UI +```{include} ../_inc/_semantic-ui-deprecation.md +``` + Volto uses [Semantic UI](https://semantic-ui.com/) and [React Semantic UI](https://react.semantic-ui.com) (via [semantic-ui-less](https://github.com/Semantic-Org/Semantic-UI-LESS)) diff --git a/docs/source/theming/custom-styling.md b/docs/source/theming/custom-styling.md index 9cb634f9e0..0c7f330d7b 100644 --- a/docs/source/theming/custom-styling.md +++ b/docs/source/theming/custom-styling.md @@ -11,6 +11,9 @@ myst: ## Semantic UI +```{include} ../_inc/_semantic-ui-deprecation.md +``` + For styling our website in Volto we use Semantic UI. It uses LESS as the underlying technology. By default Volto uses the Pastanaga theme but any theme can be used. A theme has the following folder structure: diff --git a/docs/source/theming/index.md b/docs/source/theming/index.md index e2577b2c31..5ea976d5fc 100644 --- a/docs/source/theming/index.md +++ b/docs/source/theming/index.md @@ -11,6 +11,8 @@ myst: This section of the documentation describes theming in Volto. +```{include} ../_inc/_semantic-ui-deprecation.md +``` ## Conceptual guides diff --git a/docs/source/theming/semanticui-theming.md b/docs/source/theming/semanticui-theming.md index 28a312ff94..2372e2ba6a 100644 --- a/docs/source/theming/semanticui-theming.md +++ b/docs/source/theming/semanticui-theming.md @@ -9,6 +9,9 @@ myst: # Semantic UI Theming +```{include} ../_inc/_semantic-ui-deprecation.md +``` + As we hinted previously, Semantic UI theming happens in several stages using several layers of inheritance. Let's discover each of these layers. diff --git a/docs/source/theming/theming-engine.md b/docs/source/theming/theming-engine.md index 19280c087c..5ce864dd2a 100644 --- a/docs/source/theming/theming-engine.md +++ b/docs/source/theming/theming-engine.md @@ -9,6 +9,9 @@ myst: # How does the theming engine work? +```{include} ../_inc/_semantic-ui-deprecation.md +``` + It basically uses heavily the LESS precompiler language features. No code is involved (which is good). ## `theme.config` diff --git a/docs/source/theming/theming-strategy.md b/docs/source/theming/theming-strategy.md index ab1fc934fe..fd98ecdbe0 100644 --- a/docs/source/theming/theming-strategy.md +++ b/docs/source/theming/theming-strategy.md @@ -9,6 +9,9 @@ myst: # Theming Strategy +```{include} ../_inc/_semantic-ui-deprecation.md +``` + One approaches the theming of a Volto site usually with a predefined mockup or design from a design agency or an UX/UI designer in the form of Sketch files (a common design and prototyping tool), a series of photoshop or PDFs with the diff --git a/docs/source/upgrade-guide/index.md b/docs/source/upgrade-guide/index.md index 95211bce3b..add210b120 100644 --- a/docs/source/upgrade-guide/index.md +++ b/docs/source/upgrade-guide/index.md @@ -549,6 +549,12 @@ If you've applied custom styles or shadowed this component, you might need to ma Effective with Volto 18.0.0-alpha.42, a new feature introduced a breaking change in the boilerplates created using `@plone/generator-volto` 9.0.0-alpha.17 and earlier. ``` +```{deprecated} Volto 18.0.0-alpha.43 +The `yarn`-based generator [`@plone/generator-volto`](https://www.npmjs.com/package/@plone/generator-volto) package and project boilerplates generated from it are deprecated and will not receive any further updates. +The recommended way of generating a project boilerplate is [Cookieplone](https://github.com/plone/cookieplone). +Please update your code to use the `pnpm` based setup. +``` + You need to change your {file}`razzle.config.js` file in the root of your boilerplate. ```diff @@ -607,8 +613,10 @@ Add this object to the `pnpm` key in your project {file}`package.json`. ``` The Node.js-based Volto project boilerplate generator is deprecated from Volto 18 onwards. -After the release of Volto 18, it will be marked as deprecated, archived, and it won't receive any further updates. +It is marked as deprecated, archived, and it won't receive any further updates. Although you can still migrate your project to Volto 18 using this boilerplate, you should migrate to using [Cookieplone](https://github.com/plone/cookieplone). +See {ref}`upgrade-18-cookieplone-label` for details. + ##### Alternative diff --git a/packages/volto/news/6541.documentation b/packages/volto/news/6541.documentation new file mode 100644 index 0000000000..cf25444498 --- /dev/null +++ b/packages/volto/news/6541.documentation @@ -0,0 +1,2 @@ +Amended version policy documentation. @sneridagh +Added deprecation notice for Semantic UI theming.