From 10459fd52bdd5f4d613d9c818069c10cfaac254f Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Sat, 14 Dec 2024 14:13:49 +0100 Subject: [PATCH 01/11] First version --- docs/source/_inc/_branch-policy.md | 9 +++-- .../_inc/_install-browser-reqs-volto.md | 10 ++++++ docs/source/contributing/version-policy.md | 36 +++++++++++++------ 3 files changed, 41 insertions(+), 14 deletions(-) create mode 100644 docs/source/_inc/_install-browser-reqs-volto.md diff --git a/docs/source/_inc/_branch-policy.md b/docs/source/_inc/_branch-policy.md index 22046b8266..90a522a990 100644 --- a/docs/source/_inc/_branch-policy.md +++ b/docs/source/_inc/_branch-policy.md @@ -31,11 +31,14 @@ 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. + Upon the final release of version `19.0.0`, the `18.x.x` branch line will be no longer supported. 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 when Volto 18 was released. + `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/_install-browser-reqs-volto.md b/docs/source/_inc/_install-browser-reqs-volto.md new file mode 100644 index 0000000000..b5db8d42ac --- /dev/null +++ b/docs/source/_inc/_install-browser-reqs-volto.md @@ -0,0 +1,10 @@ +You can view the list of supported browsers for Volto at [Browserslist](https://browsersl.ist/#q=%3E1%25%0Alast+4+versions%0AFirefox+ESR%0Anot+dead). + +These browsers are set according to the `browserslist` key in Volto's [`package.json`](https://github.com/plone/volto/blob/1aff8d0451f5cb375ca9f5afe9b2b72a0555afd8/packages/volto/package.json#L170-L176) file, whose content is below. + +```shell +>1% +last 4 versions +Firefox ESR +not dead +``` diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index fe42d3d1d5..e686e5ec45 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -16,10 +16,18 @@ 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 + +```{important} +`@plone/volto-generator` is deprecated, unmaintaned, and its usage is discouraged from Volto 18.0.0. +For new projects, please use [Cookieplone](https://github.com/plone/cookieplone) instead. +In case of having an existing project and you need to upgrade to Volto 18 but don't have time to migrate to use Cookieplone, you can still use it. +``` + +`@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 | |-------------------|---------------| @@ -40,10 +48,11 @@ 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.12 | 18.0.0 | +| 6.0 | 3.8-3.11 | 16.0.0 or 17.0.0 | +| 5.2 | 2.7, 3.6-3.8 | 15.0.0 | On Plone 6, we recommend using the known good set (KGS) of package versions that are specified in the Plone release. @@ -72,6 +81,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 | Volto | +| ------- | ----------- | +| 20, 22 | Volto 18 | +| 18, 20 | Volto 17 | +| 16, 18 | Volto 16 | + - Node.js 22 LTS: Supported since Volto 18. - Node.js 20 LTS: Supported since Volto 17. - Node.js 18: No longer supported. It was supported in Volto 16 - 17. @@ -83,11 +98,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 From 1cfe19c1c1e9253e7562b8de6eda4f81df3ec4ad Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Sat, 14 Dec 2024 16:29:23 +0100 Subject: [PATCH 02/11] Deprecation warning for SemanticUI theming. --- docs/source/theming/about-semantic.md | 5 +++++ docs/source/theming/custom-styling.md | 5 +++++ docs/source/theming/index.md | 4 ++++ docs/source/theming/semanticui-theming.md | 5 +++++ docs/source/theming/theming-a-base-theme.md | 5 +++++ docs/source/theming/theming-engine.md | 5 +++++ docs/source/theming/theming-strategy.md | 5 +++++ 7 files changed, 34 insertions(+) diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index b3aaf62767..9036150db5 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -9,6 +9,11 @@ myst: # About Semantic UI +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + 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..c9976f44ec 100644 --- a/docs/source/theming/custom-styling.md +++ b/docs/source/theming/custom-styling.md @@ -7,6 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Custom, Styling, Semantic UI, LESS, Pastanaga" --- +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + # Custom Styling ## Semantic UI diff --git a/docs/source/theming/index.md b/docs/source/theming/index.md index e2577b2c31..39e1e93c3c 100644 --- a/docs/source/theming/index.md +++ b/docs/source/theming/index.md @@ -11,6 +11,10 @@ myst: This section of the documentation describes theming in Volto. +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` ## Conceptual guides diff --git a/docs/source/theming/semanticui-theming.md b/docs/source/theming/semanticui-theming.md index 28a312ff94..cfad6a013c 100644 --- a/docs/source/theming/semanticui-theming.md +++ b/docs/source/theming/semanticui-theming.md @@ -7,6 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Semantic UI, Theming" --- +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + # Semantic UI Theming As we hinted previously, Semantic UI theming happens in several stages using several layers of inheritance. diff --git a/docs/source/theming/theming-a-base-theme.md b/docs/source/theming/theming-a-base-theme.md index f3730dead1..0db2ab93fe 100644 --- a/docs/source/theming/theming-a-base-theme.md +++ b/docs/source/theming/theming-a-base-theme.md @@ -7,6 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, themes, Volto Light Theme" --- +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + # Customize a base theme You can customize a base theme for your add-on. diff --git a/docs/source/theming/theming-engine.md b/docs/source/theming/theming-engine.md index 19280c087c..7dcff5a611 100644 --- a/docs/source/theming/theming-engine.md +++ b/docs/source/theming/theming-engine.md @@ -7,6 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, theming, engine, LESS" --- +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + # How does the theming engine work? It basically uses heavily the LESS precompiler language features. No code is involved (which is good). diff --git a/docs/source/theming/theming-strategy.md b/docs/source/theming/theming-strategy.md index ab1fc934fe..27a8d29899 100644 --- a/docs/source/theming/theming-strategy.md +++ b/docs/source/theming/theming-strategy.md @@ -7,6 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Theming, Strategy" --- +```{deprecated} Volto 18 +Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. +Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +``` + # Theming Strategy One approaches the theming of a Volto site usually with a predefined mockup or From 1a3ddefe685b6b9c3b1e26e79afc06511c9a83e0 Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Sat, 14 Dec 2024 16:30:45 +0100 Subject: [PATCH 03/11] Changelog --- packages/volto/news/6541.documentation | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 packages/volto/news/6541.documentation diff --git a/packages/volto/news/6541.documentation b/packages/volto/news/6541.documentation new file mode 100644 index 0000000000..5b262104a5 --- /dev/null +++ b/packages/volto/news/6541.documentation @@ -0,0 +1,2 @@ +Amended version-policy docs. @sneridagh +Added deprecation notice for SemanticUI theming. From 7d0d06dc048a62066fcd55013d98e0b3feb1ed97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Sun, 15 Dec 2024 18:12:37 +0100 Subject: [PATCH 04/11] Apply suggestions from code review Co-authored-by: Steve Piercy --- docs/source/contributing/version-policy.md | 11 ++++------- docs/source/theming/about-semantic.md | 6 ++++-- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index e686e5ec45..219dc504a2 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -19,10 +19,9 @@ This chapter describes the versions of software that Volto supports and how Volt ## `@plone/volto-generator` compatibility with Volto ```{deprecated} Volto 18.0.0 - -```{important} -`@plone/volto-generator` is deprecated, unmaintaned, and its usage is discouraged from Volto 18.0.0. -For new projects, please use [Cookieplone](https://github.com/plone/cookieplone) instead. +`@plone/volto-generator` was deprecated in Volto 18.0.0. +It is not maintained, and you should not use it. +For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead. In case of having an existing project and you need to upgrade to Volto 18 but don't have time to migrate to use Cookieplone, you can still use it. ``` @@ -87,8 +86,6 @@ We recommend using the current LTS version. | 18, 20 | Volto 17 | | 16, 18 | Volto 16 | -- Node.js 22 LTS: Supported since Volto 18. -- Node.js 20 LTS: Supported since Volto 17. - 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. @@ -98,7 +95,7 @@ We recommend using the current LTS version. (version-policy-supported-browsers)= -### Supported web browsers +## Supported web browsers ```{include} /_inc/_install-browser-reqs-volto.md ``` diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index 9036150db5..258464a2d2 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -10,8 +10,10 @@ myst: # About Semantic UI ```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +Semantic UI development and maintenance has sputtered 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. ``` Volto uses [Semantic UI](https://semantic-ui.com/) and From 8dc2ab74c98c720d0a74a60a0f0a9cbacb9b13fe Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 16 Dec 2024 13:00:05 +0100 Subject: [PATCH 05/11] Add reference to Plone 6.1 and the release schedule page. Remove confusing paragraph. --- docs/source/_inc/_branch-policy.md | 2 +- docs/source/contributing/version-policy.md | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/_inc/_branch-policy.md b/docs/source/_inc/_branch-policy.md index 90a522a990..e91216ba59 100644 --- a/docs/source/_inc/_branch-policy.md +++ b/docs/source/_inc/_branch-policy.md @@ -33,7 +33,7 @@ canary `18.x.x` : `18.x.x` is the current stable and actively developed branch in git. - Upon the final release of version `19.0.0`, the `18.x.x` branch line will be no longer supported. + 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` diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index 219dc504a2..2e43a9d4c8 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -22,7 +22,6 @@ This chapter describes the versions of software that Volto supports and how Volt `@plone/volto-generator` was deprecated in Volto 18.0.0. It is not maintained, and you should not use it. For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead. -In case of having an existing project and you need to upgrade to Volto 18 but don't have time to migrate to use Cookieplone, you can still use it. ``` `@plone/volto-generator` is a tool that generates a Volto project. From 3bb6191e6fab282dbcca82bbc63bb6ffcd2a07ac Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 16 Dec 2024 13:07:46 +0100 Subject: [PATCH 06/11] Use an inc for the SemanticUI notice, move under titles --- docs/source/_inc/_install-browser-reqs-volto.md | 10 ---------- docs/source/_inc/_semanticui-deprecation.md | 6 ++++++ docs/source/contributing/version-policy.md | 2 +- docs/source/theming/about-semantic.md | 6 +----- docs/source/theming/custom-styling.md | 8 +++----- docs/source/theming/index.md | 4 +--- docs/source/theming/semanticui-theming.md | 8 +++----- docs/source/theming/theming-a-base-theme.md | 5 ----- docs/source/theming/theming-engine.md | 8 +++----- docs/source/theming/theming-strategy.md | 8 +++----- 10 files changed, 21 insertions(+), 44 deletions(-) delete mode 100644 docs/source/_inc/_install-browser-reqs-volto.md create mode 100644 docs/source/_inc/_semanticui-deprecation.md diff --git a/docs/source/_inc/_install-browser-reqs-volto.md b/docs/source/_inc/_install-browser-reqs-volto.md deleted file mode 100644 index b5db8d42ac..0000000000 --- a/docs/source/_inc/_install-browser-reqs-volto.md +++ /dev/null @@ -1,10 +0,0 @@ -You can view the list of supported browsers for Volto at [Browserslist](https://browsersl.ist/#q=%3E1%25%0Alast+4+versions%0AFirefox+ESR%0Anot+dead). - -These browsers are set according to the `browserslist` key in Volto's [`package.json`](https://github.com/plone/volto/blob/1aff8d0451f5cb375ca9f5afe9b2b72a0555afd8/packages/volto/package.json#L170-L176) file, whose content is below. - -```shell ->1% -last 4 versions -Firefox ESR -not dead -``` diff --git a/docs/source/_inc/_semanticui-deprecation.md b/docs/source/_inc/_semanticui-deprecation.md new file mode 100644 index 0000000000..cc8f3869f1 --- /dev/null +++ b/docs/source/_inc/_semanticui-deprecation.md @@ -0,0 +1,6 @@ +```{deprecated} Volto 18 +Semantic UI development and maintenance has sputtered 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 2e43a9d4c8..47e62963e8 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -96,7 +96,7 @@ We recommend using the current LTS version. ## Supported web browsers -```{include} /_inc/_install-browser-reqs-volto.md +```{include} ../../_inc/_install-browser-reqs-volto.md ``` diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index 258464a2d2..340dc2e6a6 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -9,11 +9,7 @@ myst: # About Semantic UI -```{deprecated} Volto 18 -Semantic UI development and maintenance has sputtered 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. +```{include} /_inc/_semanticui-deprecation.md ``` Volto uses [Semantic UI](https://semantic-ui.com/) and diff --git a/docs/source/theming/custom-styling.md b/docs/source/theming/custom-styling.md index c9976f44ec..ae8d0d8ba0 100644 --- a/docs/source/theming/custom-styling.md +++ b/docs/source/theming/custom-styling.md @@ -7,15 +7,13 @@ myst: "keywords": "Volto, Plone, frontend, React, Custom, Styling, Semantic UI, LESS, Pastanaga" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Custom Styling ## Semantic UI +```{include} /_inc/_semanticui-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 39e1e93c3c..d5d77ed936 100644 --- a/docs/source/theming/index.md +++ b/docs/source/theming/index.md @@ -11,9 +11,7 @@ myst: This section of the documentation describes theming in Volto. -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +```{include} /_inc/_semanticui-deprecation.md ``` ## Conceptual guides diff --git a/docs/source/theming/semanticui-theming.md b/docs/source/theming/semanticui-theming.md index cfad6a013c..5a4ed80914 100644 --- a/docs/source/theming/semanticui-theming.md +++ b/docs/source/theming/semanticui-theming.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Semantic UI, Theming" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Semantic UI Theming +```{include} /_inc/_semanticui-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-a-base-theme.md b/docs/source/theming/theming-a-base-theme.md index 0db2ab93fe..f3730dead1 100644 --- a/docs/source/theming/theming-a-base-theme.md +++ b/docs/source/theming/theming-a-base-theme.md @@ -7,11 +7,6 @@ myst: "keywords": "Volto, Plone, frontend, React, themes, Volto Light Theme" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Customize a base theme You can customize a base theme for your add-on. diff --git a/docs/source/theming/theming-engine.md b/docs/source/theming/theming-engine.md index 7dcff5a611..e7c993f22d 100644 --- a/docs/source/theming/theming-engine.md +++ b/docs/source/theming/theming-engine.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, theming, engine, LESS" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # How does the theming engine work? +```{include} /_inc/_semanticui-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 27a8d29899..d8a6bbcf47 100644 --- a/docs/source/theming/theming-strategy.md +++ b/docs/source/theming/theming-strategy.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Theming, Strategy" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Theming Strategy +```{include} /_inc/_semanticui-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 From 097dda69c285c2df2a88d7c5acc6121feb18d528 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Mon, 16 Dec 2024 17:49:29 +0100 Subject: [PATCH 07/11] Apply suggestions from code review Co-authored-by: Steve Piercy --- docs/source/contributing/version-policy.md | 2 +- docs/source/theming/about-semantic.md | 2 +- packages/volto/news/6541.documentation | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index 47e62963e8..5784c89edd 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -49,7 +49,7 @@ The versions of Python that are supported in Volto depend on the version of Plon | Plone | Python | Volto | | ----- | ------------ | ---------------- | | 6.1 | 3.10-3.12 | 18.0.0 | -| 6.0 | 3.8-3.11 | 16.0.0 or 17.0.0 | +| 6.0 | 3.8-3.12 | 16.0.0 or 17.0.0 | | 5.2 | 2.7, 3.6-3.8 | 15.0.0 | On Plone 6, we recommend using the known good set (KGS) of package versions that are specified in the Plone release. diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index 340dc2e6a6..9b23b64a5e 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -9,7 +9,7 @@ myst: # About Semantic UI -```{include} /_inc/_semanticui-deprecation.md +```{include} ../_inc/_semantic-ui-deprecation.md ``` Volto uses [Semantic UI](https://semantic-ui.com/) and diff --git a/packages/volto/news/6541.documentation b/packages/volto/news/6541.documentation index 5b262104a5..ba2b4aa0ba 100644 --- a/packages/volto/news/6541.documentation +++ b/packages/volto/news/6541.documentation @@ -1,2 +1,2 @@ Amended version-policy docs. @sneridagh -Added deprecation notice for SemanticUI theming. +Added deprecation notice for Semantic UI theming. From 23723b9765f0dcd7f2941048c3fbed11a4d3474d Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 16 Dec 2024 17:51:27 +0100 Subject: [PATCH 08/11] Rename _semantic-ui-deprecation.md --- .../{_semanticui-deprecation.md => _semantic-ui-deprecation.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/source/_inc/{_semanticui-deprecation.md => _semantic-ui-deprecation.md} (100%) diff --git a/docs/source/_inc/_semanticui-deprecation.md b/docs/source/_inc/_semantic-ui-deprecation.md similarity index 100% rename from docs/source/_inc/_semanticui-deprecation.md rename to docs/source/_inc/_semantic-ui-deprecation.md From 99292c657dd58fdeeb95d318a9abaac24ff82485 Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 16 Dec 2024 17:54:00 +0100 Subject: [PATCH 09/11] Complete what legacy means --- docs/source/_inc/_branch-policy.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/_inc/_branch-policy.md b/docs/source/_inc/_branch-policy.md index e91216ba59..ee8a6771f6 100644 --- a/docs/source/_inc/_branch-policy.md +++ b/docs/source/_inc/_branch-policy.md @@ -38,6 +38,9 @@ canary `17.x.x` : `17.x.x` is no longer supported and became legacy when Volto 18 was released. + It won't receive any bug fixes nor security updates. + It is recommended that you update to 18.x.x. + If you need a bug fix or security update for this version, please submit a pull request, and the Volto Team will review it to determine whether it's suitable to merge. `16.x.x` : This version of Volto has the [same maintenance and support schedule as Plone 6.0](https://plone.org/download/release-schedule). From 3b84acad563420785183c3a7d260c692617de9f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Tue, 17 Dec 2024 08:16:31 +0100 Subject: [PATCH 10/11] Apply suggestions from code review Co-authored-by: David Glick Co-authored-by: Steve Piercy --- docs/source/_inc/_semantic-ui-deprecation.md | 2 +- docs/source/contributing/version-policy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/_inc/_semantic-ui-deprecation.md b/docs/source/_inc/_semantic-ui-deprecation.md index cc8f3869f1..86a1b628a5 100644 --- a/docs/source/_inc/_semantic-ui-deprecation.md +++ b/docs/source/_inc/_semantic-ui-deprecation.md @@ -1,5 +1,5 @@ ```{deprecated} Volto 18 -Semantic UI development and maintenance has sputtered since 2018. +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 5784c89edd..a361a2cdb9 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -21,7 +21,7 @@ This chapter describes the versions of software that Volto supports and how Volt ```{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, use [Cookieplone](https://github.com/plone/cookieplone) instead. +For new projects, follow {doc}`plone:install/create-project-cookieplone` instead. ``` `@plone/volto-generator` is a tool that generates a Volto project. From 427e449d66636a17cf415edafa17470f1f6dd87e Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Tue, 17 Dec 2024 08:30:15 +0100 Subject: [PATCH 11/11] Remove contradicting statement in 17.x.x branch, create an entry to clarify what legacy means. --- docs/source/_inc/_branch-policy.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/_inc/_branch-policy.md b/docs/source/_inc/_branch-policy.md index ee8a6771f6..6d7e054483 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. + It is recommended that you update to minor Plone releases as soon as possible. + They won't receive any new features. + They might receive occasional bugfixes or security updates, via a pull request, and it's approved by 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. @@ -38,7 +45,6 @@ canary `17.x.x` : `17.x.x` is no longer supported and became legacy when Volto 18 was released. - It won't receive any bug fixes nor security updates. It is recommended that you update to 18.x.x. If you need a bug fix or security update for this version, please submit a pull request, and the Volto Team will review it to determine whether it's suitable to merge.