plone / volto

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

Update volto-slate configuration to indicate it is now part of the core. #5886

Closed MostafaMagdyy closed 1 month ago

MostafaMagdyy commented 1 month ago

Fixes #5342 for volto docs to indicate that volto-slate is now part of the core

netlify[bot] commented 1 month ago

Deploy Preview for volto ready!

Name Link
Latest commit 36416a7879884fd066aeb3147879cbc06b7556b0
Latest deploy log https://app.netlify.com/sites/volto/deploys/65f6cfa701070600087c43bd
Deploy Preview https://deploy-preview-5886--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.

netlify[bot] commented 1 month ago

Deploy Preview for plone-components canceled.

Name Link
Latest commit 36416a7879884fd066aeb3147879cbc06b7556b0
Latest deploy log https://app.netlify.com/sites/plone-components/deploys/65f6cfa770fbf2000822f480
MostafaMagdyy commented 1 month ago

Please review this pull request. @stevepiercy ,@polyester, could you please take a look and provide your feedback? Thank you!

stevepiercy commented 1 month ago

@MostafaMagdyy you have two pull requests open for the same issue (#5884). Neither will be reviewed until you close one. See Item 3 under Things not to do.

MostafaMagdyy commented 1 month ago

@stevepiercy Sorry for inconvenience. I closed the first one because I did not pass the Plone contributor agreement. Now you will find only one regarding this issue

MostafaMagdyy commented 1 month ago

@stevepiercy Thanks for your help regarding prioritizing the important clause. I have committed the suggested changes already. Please check if there are any other changes needed regarding this issue, Also I have reviewed the files within the configuration/volto-slate directory. and found these files focus on extending Volto-Slate into projects that use Volto, with guidance on creating customized plugins. So, I am not sure whether they need to be updated

One thing I noticed that might require updating is this description is

volto-slate API

The volto-slate API provides methods to integrate the Slate editor into projects that use Plone's React-based frontend Volto.

I suggest it to be

The volto-slate API provides methods to extends the Slate editor into projects that use Plone's React-based frontend Volto.

stevepiercy commented 1 month ago

@MostafaMagdyy it is actually an integration, not an extension, so we'll leave it as is.

I also reviewed the rest of the documentation in volto-slate, and it does not need any revisions.

This PR is OK to merge. Thank you!

stevepiercy commented 1 month ago

Actually, I want to make sure that all tests pass. For some reason "Acceptance Tests / Core Blocks - Listing (18.x) (pull_request)" did not pass. I restarted it to see if it is flaky and will pass this time.