Amend version policy docs #6541

sneridagh · 2024-12-14T13:14:20Z

First draft

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

netlify · 2024-12-14T13:14:40Z

✅ Deploy Preview for plone-components canceled.

Name	Link
🔨 Latest commit	`427e449`
🔍 Latest deploy log	https://app.netlify.com/sites/plone-components/deploys/676128a7c807d40008524076

docs/source/_inc/_branch-policy.md

stevepiercy · 2024-12-14T21:50:23Z

docs/source/_inc/_install-browser-reqs-volto.md

We need to remove the copy of this file from the documentation repo, and refer to this include instead, in a separate PR.

Can we do that, from another repo?

Example. Adjust relative paths as needed.

In Volto docs.

```{include} ../_inc/_install-operating-system.md ```

In documentation.

```{include} ../../volto/_inc/_install-operating-system.md ```

IOW, when you use the include in Volto, then you can refer to it in documentation, after it gets merged in a PR, of course. You cannot go the reverse direction.

Done. Removed the local inc.

That's not what I meant. Please read my original statement. The separate PR would be in Documentation.

but the original is in docs already.

We need to remove the copy of this file from the documentation repo

The docs in Volto have no idea that plone/documentation exists with regard to includes. Please restore the file /_inc/_install-operating-system.md here, restore the include directive, and we will delete the original from plone/documentation.

You can verify this by trying to build docs locally.

docs/source/contributing/version-policy.md

docs/source/theming/about-semantic.md

docs/source/theming/custom-styling.md

Co-authored-by: Steve Piercy <[email protected]>

…using paragraph.

docs/source/contributing/version-policy.md

docs/source/_inc/_branch-policy.md

stevepiercy · 2024-12-15T17:42:51Z

docs/source/_inc/_branch-policy.md

    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.


I wonder if we should say something more for 17.x.x? For example, let's say I have a project with Plone 6.0 and Volto 17. What should I do? Should I upgrade both Plone to 6.1 and Volto to 18? If so, then we need to also link directly to each upgrade guide.

Suggested change

: `17.x.x` is no longer supported and became legacy when Volto 18 was released.

: `17.x.x` is no longer supported and became legacy when Volto 18 was released.

It's not mandatory to upgrade. It can get some updates, if people still care for it, and the Volto Team approve them.

@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.

docs/source/contributing/version-policy.md

stevepiercy · 2024-12-15T17:49:18Z

docs/source/theming/about-semantic.md

+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.


As a side note, after seeing all the added admonitions in theming docs regarding Semantic UI, where would I look now for theming docs for the new way of theming? We should include that in the admonition, too.

Nowhere to look yet. We should start sending the message: "Whatever you use for theming your site, but SemanticUI, is fine. You can continue using it if you want, but core will abandon it in Plone 7."

I completed the info on 17.x.x

docs/source/_inc/_branch-policy.md

stevepiercy · 2024-12-16T13:06:02Z

docs/source/_inc/_install-browser-reqs-volto.md

That's not what I meant. Please read my original statement. The separate PR would be in Documentation.

stevepiercy · 2024-12-16T13:08:43Z

docs/source/_inc/_semanticui-deprecation.md

Let's rename it to _semantic-ui-deprecation.md because there is a space in its official brand name.

docs/source/theming/about-semantic.md

packages/volto/news/6541.documentation

Co-authored-by: Steve Piercy <[email protected]>

davisagli · 2024-12-16T17:01:09Z

docs/source/_inc/_branch-policy.md

+:   `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.


This seems to contradict line 41.

I'm adding a "legacy" entry at the top of the document to clarify it.

davisagli · 2024-12-16T17:01:48Z

docs/source/_inc/_semantic-ui-deprecation.md

@@ -0,0 +1,6 @@
+```{deprecated} Volto 18
+Semantic UI development and maintenance has sputtered since 2018.


Suggested change

Semantic UI development and maintenance has sputtered since 2018.

Semantic UI development and maintenance has been inconsistent since 2018.

davisagli · 2024-12-16T17:03:33Z

docs/source/contributing/version-policy.md

+```{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.


We should link to https://6.docs.plone.org/install/create-project-cookieplone.html here, not the Cookieplone repository.

The whole sentence needs a rewrite. This syntax should work via Intersphinx for both here and plone/documentation.

Suggested change

For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead.

For new projects, follow {doc}`plone:install/create-project-cookieplone` instead.

=>

For new projects, follow Install Plone with Cookieplone instead.

davisagli · 2024-12-16T17:04:14Z

docs/source/contributing/version-policy.md

+```
+
+`@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 |
 |-------------------|---------------|


The next line makes it sound like it's still supported for Volto 18, we need to change that.

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.

No, we started to update it for Volto 18 but then realized we needed to create Cookieplone instead, because the structure was too different.

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

"It does work" but it's true that maybe we should not advertise it, it could be confusing.

Well, I just tried it, and it didn't work for me. But it could be that the Training I followed has incorrect information.

@stevepiercy there's still an acceptance test for it in place. So it should still work for 18. For project, the add-on template is not being tested. What did you do? That training could be outdated.

I followed the exact instructions published in that training, pretending to be a learner.

Co-authored-by: David Glick <[email protected]> Co-authored-by: Steve Piercy <[email protected]>

…larify what legacy means.

First version

10459fd

sneridagh requested a review from stevepiercy December 14, 2024 13:14

sneridagh added 2 commits December 14, 2024 16:29

Deprecation warning for SemanticUI theming.

1cfe19c

Changelog

1a3ddef

sneridagh mentioned this pull request Dec 14, 2024

[docs] Version policy needs update for Plone 6.1, Volto 18, Node.js compat #6540

Open

stevepiercy requested changes Dec 14, 2024

View reviewed changes

stevepiercy mentioned this pull request Dec 15, 2024

Unexpected non-whitespace character after JSON in @plone/volto #6528

Open

sneridagh and others added 3 commits December 15, 2024 18:12

Apply suggestions from code review

7d0d06d

Co-authored-by: Steve Piercy <[email protected]>

Add reference to Plone 6.1 and the release schedule page. Remove conf…

8dc2ab7

…using paragraph.

Use an inc for the SemanticUI notice, move under titles

3bb6191

stevepiercy requested changes Dec 16, 2024

View reviewed changes

sneridagh and others added 3 commits December 16, 2024 17:49

Apply suggestions from code review

097dda6

Co-authored-by: Steve Piercy <[email protected]>

Rename _semantic-ui-deprecation.md

23723b9

Complete what legacy means

99292c6

davisagli reviewed Dec 16, 2024

View reviewed changes

This was referenced Dec 17, 2024

Release checklist Plone 6.1.0b2 plone/Products.CMFPlone#4080

Open

Update documentation to replace jsconfig.json with tsconfig.json for Volto Version 17 plone/training#901

Open

sneridagh and others added 2 commits December 17, 2024 08:16

Apply suggestions from code review

3b84aca

Co-authored-by: David Glick <[email protected]> Co-authored-by: Steve Piercy <[email protected]>

Remove contradicting statement in 17.x.x branch, create an entry to c…

427e449

…larify what legacy means.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Amend version policy docs #6541

Amend version policy docs #6541

sneridagh commented Dec 14, 2024 •

edited by github-actions bot

Loading

netlify bot commented Dec 14, 2024 •

edited

Loading

stevepiercy Dec 14, 2024

sneridagh Dec 15, 2024

stevepiercy Dec 15, 2024

sneridagh Dec 16, 2024

stevepiercy Dec 16, 2024

sneridagh Dec 16, 2024

stevepiercy Dec 17, 2024

stevepiercy Dec 15, 2024

sneridagh Dec 16, 2024

davisagli Dec 16, 2024

stevepiercy Dec 15, 2024

sneridagh Dec 16, 2024

sneridagh Dec 16, 2024

stevepiercy Dec 16, 2024

stevepiercy Dec 16, 2024

sneridagh Dec 16, 2024

davisagli Dec 16, 2024

sneridagh Dec 17, 2024

davisagli Dec 16, 2024 •

edited by stevepiercy

Loading

davisagli Dec 16, 2024

stevepiercy Dec 17, 2024

davisagli Dec 16, 2024

stevepiercy Dec 17, 2024

davisagli Dec 17, 2024

stevepiercy Dec 17, 2024

sneridagh Dec 17, 2024

stevepiercy Dec 17, 2024 •

edited

Loading

sneridagh Dec 17, 2024

stevepiercy Dec 17, 2024

	: `17.x.x` is no longer supported and became legacy when Volto 18 was released.
	: `17.x.x` is no longer supported and became legacy when Volto 18 was released.

		@@ -0,0 +1,6 @@
		```{deprecated} Volto 18
		Semantic UI development and maintenance has sputtered since 2018.

	For new projects, use [Cookieplone](https://github.com/plone/cookieplone) instead.
	For new projects, follow {doc}`plone:install/create-project-cookieplone` instead.

Amend version policy docs #6541

Are you sure you want to change the base?

Amend version policy docs #6541

Conversation

sneridagh commented Dec 14, 2024 • edited by github-actions bot Loading

netlify bot commented Dec 14, 2024 • edited Loading

✅ Deploy Preview for plone-components canceled.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davisagli Dec 16, 2024 • edited by stevepiercy Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stevepiercy Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sneridagh commented Dec 14, 2024 •

edited by github-actions bot

Loading

netlify bot commented Dec 14, 2024 •

edited

Loading

davisagli Dec 16, 2024 •

edited by stevepiercy

Loading

stevepiercy Dec 17, 2024 •

edited

Loading