Skip to content

Conversation

@mauritsvanrees
Copy link
Member

@mauritsvanrees mauritsvanrees commented Dec 10, 2025

For technical review, I tag @davisagli @gforcada @petschki.

I have fixed most Vale feedback, except these, which I don't know how to write better:

venv/bin/vale --no-wrap  docs/backend/upgrading/version-specific-migration/upgrade-to-62.md

 docs/backend/upgrading/version-specific-migration/upgrade-to-62.md
 33:11  suggestion  'is deprecated' looks like passive voice.    Microsoft.Passive         
 33:44  suggestion  'be removed' looks like passive voice.       Microsoft.Passive         
 62:29  warning     Avoid using acronyms in a title or heading.  Microsoft.HeadingAcronyms 

That last one is for "Classic UI" in the last header, I think.


📚 Documentation preview 📚: https://plone6--2002.org.readthedocs.build/

Specifically this page: /backend/upgrading/version-specific-migration/upgrade-to-62.

@stevepiercy
Copy link
Contributor

You can ignore Vale warnings and suggestions, but errors should get a look. As part of my routine maintenance, I try to address the errors and reduce them. There's a long way to go yet, so the only thing I really care about for now is to not introduce new errors. Often it turns out to be a candidate for a new term in the glossary, and sometimes it's just some bad MyST markup.

I'll do a thorough editorial review in the next day or so, after the smart people do a technical review. Thanks for the PR!

gforcada
gforcada previously approved these changes Dec 11, 2025
Copy link
Member

@gforcada gforcada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice write up!

@github-project-automation github-project-automation bot moved this from New to Approved in Plone Documentation Dec 11, 2025
petschki
petschki previously approved these changes Dec 12, 2025
Copy link
Member

@petschki petschki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @mauritsvanrees ... currently there is nothing more to say for the template movements. Progress is tracked here plone/Products.CMFPlone#3953

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor tweaks, and a question and suggestion for reference to Python docs. I'm not sure if I got it right. Thanks for your work on this. It's really good!

Comment on lines +26 to +28
There are three styles or techniques of namespaces.
For Plone only two are important: `pkg_resources` and native (sometimes referred to as implicit).
The third style is `pkgutil`, but Plone has never used it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should include references to the following terms.

If I read all that correctly, a native namespace is a subcategory of implicit namespaces. Is that right?

If so, then I'd make the following suggestion.

Suggested change
There are three styles or techniques of namespaces.
For Plone only two are important: `pkg_resources` and native (sometimes referred to as implicit).
The third style is `pkgutil`, but Plone has never used it.
There are three styles or techniques of namespaces.
For Plone, only two are important: `pkg_resources` and native, the latter of which is a subcategory of implicit namespace packages where you omit the `__init.py__` file from the namespace package directory.
The third style is `pkgutil`, but Plone has never used it.
```{seealso}
- [Native namespace packages](https://packaging.python.org/en/latest/guides/packaging-namespace-packages/#native-namespace-packages)
- [PEP 420 – Implicit Namespace Packages](https://peps.python.org/pep-0420/)
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mauritsvanrees I committed all but this one suggestion, as I'd like your thoughts on it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion seems helpful to me.

@github-project-automation github-project-automation bot moved this from Approved to In Progress in Plone Documentation Dec 14, 2025
@stevepiercy stevepiercy dismissed stale reviews from petschki and gforcada via 9c0275f December 15, 2025 10:58
Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from the pending suggestion, this looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

6 participants