plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
426 stars 575 forks source link

Update Docs: Pastanaga UI and Quanta #5903

Closed jensens closed 1 month ago

jensens commented 1 month ago

After a chat with @sneridagh about Quanta, I took the information and updated the outdated page .

netlify[bot] commented 1 month ago

Deploy Preview for plone-components canceled.

Name Link
Latest commit 627810db5d07bb13f391b49d35c776cef513a807
Latest deploy log https://app.netlify.com/sites/plone-components/deploys/65fc400939f824000842ab90
netlify[bot] commented 1 month ago

Deploy Preview for volto ready!

Name Link
Latest commit 627810db5d07bb13f391b49d35c776cef513a807
Latest deploy log https://app.netlify.com/sites/volto/deploys/65fc400a5807da0008ad6c1d
Deploy Preview https://deploy-preview-5903--volto.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jensens commented 1 month ago

It seems we have no news folder for documentation changes. I added a check. The prerelease script should find it anyway.

stevepiercy commented 1 month ago

The news folder for Volto moved since it became a monorepo to https://github.com/plone/volto/tree/main/packages/volto/news. Docs are for all the packages in the repo, which is why docs/ remains at the repo root.

jensens commented 1 month ago

The news folder for Volto moved since it became a monorepo to https://github.com/plone/volto/tree/main/packages/volto/news. Docs are for all the packages in the repo, which is why docs/ remains at the repo root.

This is why I added an allow-check for docs and looked how prereleaser.js works, which globs'**/news/*.*(breaking|feature|bugfix|documentation|internal)', finding the docs/news then as well. This should be fine this way and then all news folders are in it's place.

stevepiercy commented 1 month ago

This is why I added an allow-check for docs and looked how prereleaser.js works, which globs'**/news/*.*(breaking|feature|bugfix|documentation|internal)', finding the docs/news then as well. This should be fine this way and then all news folders are in it's place.

We already put documentation change log entries in the news items directory in packages/volto/news. We don't need another check that will not be used. It's also out of scope for this pull request, and should be discussed amongst the Volto team before making changes of this nature.

jensens commented 1 month ago

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

stevepiercy commented 1 month ago

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

Screenshot 2024-03-21 at 2 44 15 PM

The "see also" link goes to https://6.docs.plone.org/contributing/index.html#change-log-entry which provides sufficient detail.

For Volto, its repository is in a monorepo structure, consisting of several packages in the packages folder. Thus for Volto and its packages, change log entries should be created in packages/PACKAGE_NAME/news/, which is the root of the package.

I can add your suggestion, if you still think it would be beneficial. I would turn it into a snippet and include it, so that we don't use copy-paste. Please let me know. Thank you!

stevepiercy commented 1 month ago

@sneridagh I'd like your review for accuracy, and let you take the merge honors.

jensens commented 1 month ago

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

Screenshot 2024-03-21 at 2 44 15 PM

The "see also" link goes to https://6.docs.plone.org/contributing/index.html#change-log-entry which provides sufficient detail.

For Volto, its repository is in a monorepo structure, consisting of several packages in the packages folder. Thus for Volto and its packages, change log entries should be created in packages/PACKAGE_NAME/news/, which is the root of the package.

I can add your suggestion, if you still think it would be beneficial. I would turn it into a snippet and include it, so that we don't use copy-paste. Please let me know. Thank you!

Something like "in case of setup/CI/CD or documentation changes not bound to a specific package, use the PACKAGE_NAME=volto"?

sneridagh commented 1 month ago

Something like "in case of setup/CI/CD or documentation changes not bound to a specific package, use the PACKAGE_NAME=volto"?

I'd be +1 on clarifying this.

@jensens very well written, it's just awesome. Thanks a lot!