Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to upgrade projects to Cookieplone #6621

Closed
stevepiercy opened this issue Jan 24, 2025 · 9 comments · Fixed by #6626
Closed

Document how to upgrade projects to Cookieplone #6621

stevepiercy opened this issue Jan 24, 2025 · 9 comments · Fixed by #6626

Comments

@stevepiercy
Copy link
Collaborator

Although we tell developers to upgrade their projects to Cookieplone, we don't explicitly say how to do so. Without these docs, developers may be reluctant to try upgrading to Volto 18, because they don't know where to move things from the previous structure to the new one.

Originally posted by @stevepiercy in #6541 (comment)

@davisagli
Copy link
Member

@stevepiercy that notice says how at a high level: "when you want to upgrade your project, you can generate a new project using Cookieplone with the same name as your old one, and copy over your add-ons to the new project." Sounds like you're looking for a more detailed guide to doing that in a separate chapter?

@stevepiercy
Copy link
Collaborator Author

@davisagli
Copy link
Member

@stevepiercy The update to this notice which happened in #6609 is exactly what I had in mind when I wrote that comment.

@stevepiercy
Copy link
Collaborator Author

@davisagli I don't know if it needs more detail, such as copy from this folder to that folder. If you think it's good enough, then you can close this issue.

@davisagli
Copy link
Member

@stevepiercy I'm not the right person to evaluate that, since I haven't done any of these upgrades recently.

@stevepiercy
Copy link
Collaborator Author

@davisagli me neither. ☹ @plone/volto-team have any of you done such an upgrade recently who can provide notes or an outline? I'd be happy to do the necessary write up, I just don't know the necessary details.

@erral
Copy link
Member

erral commented Jan 27, 2025

I have upgraded some add-ons that way. Perhaps we can improve the text with some more details like saying which folder you should copy to which folder in the new structure

@stevepiercy
Copy link
Collaborator Author

@erral yes, please! If you can provide details, even mere notes, I would be grateful and write up docs from them.

@erral
Copy link
Member

erral commented Jan 27, 2025

Here you have some quick notes:

  • Create the project structure with cookieplone using the frontend_addon template
  • Take the contents of the src folder in the old structure, and copy them over to packages/<your-addon-name>/src/

Here you have some examples of such an update:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants