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

Update cookie* references to current Volto 18.0.0-alpha.43 release #1706

Closed
1 task
Tracked by #6123
stevepiercy opened this issue Sep 14, 2024 · 3 comments · Fixed by #1724
Closed
1 task
Tracked by #6123

Update cookie* references to current Volto 18.0.0-alpha.43 release #1706

stevepiercy opened this issue Sep 14, 2024 · 3 comments · Fixed by #1724

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Sep 14, 2024

Description

With the release of Volto 18.0.0-alpha.43, we need to review and potentially update or supplement references to cookiecutter-plone-starter, cookiecutter-zope-instance, and @plone/generator-volto with Cookieplone.

See also:

@stevepiercy stevepiercy added this to the Plone 6.1 milestone Sep 14, 2024
@stevepiercy stevepiercy moved this to Todo in Install Docs Sep 14, 2024
@stevepiercy stevepiercy moved this from New to Todo in Release Plone 6 docs Sep 14, 2024
@stevepiercy stevepiercy moved this to Backlog in Volto Roadmap Sep 14, 2024
@stevepiercy stevepiercy moved this to Pending in Volto Team Meeting Sep 14, 2024
tkimnguyen added a commit that referenced this issue Sep 18, 2024
Fix #1706 and add a bit more text about the option for trying Plone
@stevepiercy stevepiercy linked a pull request Sep 28, 2024 that will close this issue
@stevepiercy
Copy link
Contributor Author

We need to decide whether to update this page with Cookieplone, or retain it and create a second one for Cookieplone.

Most of the content applies to both cookiecutters, so I would prefer to do an update and use Sphinx Design's synched tabs to display specific content for each cookiecutter. Here's a demo: https://sphinx-design.readthedocs.io/en/latest/tabs.html#synchronised-tabs @sneridagh @davisagli @animus888 @ksuess

@davisagli
Copy link
Member

@stevepiercy Ugh, this whole page is a mess:

  1. None of it really belongs under Install
  2. A lot of the information doesn't really belong under the heading "Manage add-ons and packages". "Common management tasks" is currently a subheading but would be a more fitting title for the chapter. (Or possibly there should be an entire "Operating Plone" section with multiple chapters?)
  3. "Installation details with Cookiecutter" should be removed or maybe included as a note in the relevant "create a project" chapter
  4. "Configuration with cookiecutter-zope-instance" should go under "Common management tasks" and be renamed to "Configure the Zope instance"
  5. "Manage Plone backend packages with mxdev" has too much exposition and doesn't belong at this level of the outline. Instead we should have 2 subheadings under Common Management Tasks: "Override a core Plone package version" and "Install a package from source"
  6. All of the information about add-ons only covers backend add-ons, but doesn't explicitly say that.
  7. "Backend installation details" has details about how the Makefile created by the generator works. This isn't details about installation, and I'm not sure it really belongs here at all.
  8. If we go with the synched tab idea, we could include a tab for how to accomplish the same tasks in buildout-based installations -- if someone other than me is willing to provide that info.

@stevepiercy
Copy link
Contributor Author

@davisagli thanks for the feedback. I realize it tries to do too much, and its parts need to be moved elsewhere. Let's follow the Diataxis framework as a guide, which is consistent with your observations. Let's start a PR and collaborate on this.

@github-project-automation github-project-automation bot moved this from Backlog to Done in Volto Roadmap Oct 2, 2024
@github-project-automation github-project-automation bot moved this from Needs discussion to Done in Volto Team Meeting Oct 2, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Install Docs Oct 2, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Release Plone 6 docs Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants