Amend version policy docs #6541
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| They might receive occasional bugfixes or security updates, via a pull request, and it's approved by the Volto Team. | ||||||||||
|
There was a problem hiding this comment. This legacy section is a good addition.
Suggested change
|
||||||||||
|
|
||||||||||
| `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,16 @@ 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. | ||||||||||
|
|
||||||||||
| `18.x.x` | ||||||||||
| : `18.x.x` is the current stable and actively developed branch in git. | ||||||||||
stevepiercy marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
| 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 when Volto 18 was released. | ||||||||||
|
There was a problem hiding this comment. I wonder if we should say something more for
Suggested change
Note that we can't use a label in an include file that is used in multiple places in Sphinx (duplicate label warning), so we have to write "(see above definition)". There was a problem hiding this comment. It's not mandatory to upgrade. It can get some updates, if people still care for it, and the Volto Team approve them. There was a problem hiding this comment. @sneridagh Steve's right, if we're saying it's no longer supported, we need to give some advice on how to move forward. It's possible to upgrade to Volto 18 (i.e. by generating a new cookieplone project and moving your custom code over) without updating the backend to Plone 6.1. There was a problem hiding this comment. I edited my suggestion to adapt to the new "legacy" term. |
||||||||||
| It is recommended that you update to 18.x.x. | ||||||||||
|
There was a problem hiding this comment. The second sentence in my suggestion below was omitted from the Upgrade Guide https://6.docs.plone.org/volto/upgrade-guide/index.html#cookieplone-is-now-the-recommended-project-and-add-on-generator-for-volto-18. Should we add it there as well?
Suggested change
|
||||||||||
| 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. | ||||||||||
|
There was a problem hiding this comment. This seems to contradict line 41. There was a problem hiding this comment. I'm adding a "legacy" entry at the top of the document to clarify it. There was a problem hiding this comment. We shouldn't tell people to submit security issues or pull requests publicly. It should go through [email protected], unless I'm totally off about that. True story, I once got slapped for creating an issue stating that a Plone repo's primary branch lacked branch protection, even though it was stated publicly on the repo's home page. Also I think we should tell people to create an issue to discuss a bug fix with the Volto Team before doing any work with a pull request.
Suggested change
|
||||||||||
|
|
||||||||||
| `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. | ||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,10 +16,16 @@ This chapter describes the versions of software that Volto supports and how Volt | |
|
|
||
| (volto-generator-compatibility-with-volto-label)= | ||
|
|
||
| ## `@plone/volto-generator` compatibility with 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 | | ||
| |-------------------|---------------| | ||
|
There was a problem hiding this comment. The next line makes it sound like it's still supported for Volto 18, we need to change that. There was a problem hiding this comment. Does it work in 18? I assumed that if something works, then that means it's supported. Also if something works, it can also be deprecated. There was a problem hiding this comment. No, we started to update it for Volto 18 but then realized we needed to create Cookieplone instead, because the structure was too different. There was a problem hiding this comment. Since it doesn't work in 18, then why do we even have it in 18? https://github.com/plone/volto/tree/main/packages/generator-volto There was a problem hiding this comment. "It does work" but it's true that maybe we should not advertise it, it could be confusing. There was a problem hiding this comment. The version of @plone/volto-generator for Volto 18 was created quite early in the process of developing Volto 18, and it hasn't really gotten much attention as further changes have happened after we switched to recommending cookieplone. It doesn't surprise me that it's not working fully, and I don't think it's worth a lot of effort to fix it. We need to update trainings to use cookieplone or be clear that they are for an older version of Volto. @wesleybl There's a new structure for Volto 18, and there's no longer a distinction between an app and an addon. (Similar to how in the backend a project and an addon are both just Python packages.) Use the There was a problem hiding this comment. @sneridagh this came up in #6528 (comment). There was a problem hiding this comment. @davisagli do we also need to update these items in the upgrade guide? The first implies it's all good, especially when the second says it really ain't. There was a problem hiding this comment.
@davisagli I have some considerations about this. I think there should be an app template. However, I believe this is not the place to discuss it. I’ll create an issue in the cookieplone repository. There was a problem hiding this comment. If |
||
|
|
@@ -40,10 +46,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.1 | 3.10-3.12 | 18.0.0 | | ||
|
There was a problem hiding this comment. Awaiting response to my question in plone/Products.CMFPlone#3926 (comment) for Python 3.13 support. We can amend later, too. There was a problem hiding this comment. Amend it later. Python 3.13 support is close, but not released yet. There was a problem hiding this comment. I added a couple of comments in the release checklists just now, so we don't forget. There was a problem hiding this comment. I have released 6.0.14 and 6.1.0b2 with Python 3.13 support. I have added commit 50f1b39 to this PR to reflect this. |
||
| | 6.0 | 3.8-3.12 | 16.0.0 or 17.0.0 | | ||
| | 5.2 | 2.7, 3.6-3.8 | 15.0.0 | | ||
stevepiercy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| On Plone 6, we recommend using the known good set (KGS) of package versions that are specified in the Plone release. | ||
|
|
||
|
|
@@ -72,8 +79,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 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 +94,10 @@ We recommend using the current LTS version. | |
|
|
||
| (version-policy-supported-browsers)= | ||
|
|
||
| ## Supported web browsers | ||
|
|
||
| ```{include} ../../_inc/_install-browser-reqs-volto.md | ||
| ``` | ||
|
|
||
|
|
||
| ## Branch policy | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,6 +11,9 @@ myst: | |||||
|
|
||||||
| ## Semantic UI | ||||||
|
|
||||||
| ```{include} /_inc/_semanticui-deprecation.md | ||||||
|
There was a problem hiding this comment. Always check your local build, or at least verify on RTD previews https://volto--6541.org.readthedocs.build/theming/custom-styling.html. All includes must be relative to the current file, not the documentation root, else it will break in the main documentation. Please update the others.
Suggested change
|
||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,2 @@ | ||||||
| Amended version-policy docs. @sneridagh | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| Added deprecation notice for Semantic UI theming. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.