Explain how to create a custom pattern

[petschki]

This explains how to create a custom mockup pattern in an addon with plonecli

See #1270

---

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

[petschki]

@stevepiercy I saw that you have updated the "get started" section recently but this doesn't have to do anything with mockup or patternslib at all IMHO ... this is more a general explanation of how to create an addon for the backend with plonecli and should be placed somewhere else (maybe new sub-chapter "Create Addon" in the backend chapter ?) ... for mockup the subtemplate mockup_pattern is interesting when creating a new one.

[MrTango]

Thx for the fix. I was wondering if we could extract the bobtemplates/plonecli explanation into its own chapter.nthis way we can reference it in different places. Maybe even as an included block or something. I would like to avoid that we have this redundant infos getting outdated at some point. If we have the info in one place, it's easy to update.

[petschki]

Maybe we should do a main "development guide" chapter like the new admin guide here #1746 ...

• Development
• • create addon with cookiecutter
• • create addon with plonecli
• • create theme for Volto
• • create theme for Classic UI

[stevepiercy]

@stevepiercy I saw that you have updated the "get started" section recently

Sorry, which "get started" section? I assume you mean https://6.docs.plone.org/install/index.html#get-started. If so, then should we rename Create a project with Classic UI (stable release) to, say, "Create a backend project"?

We need to rename them all anyway, because with the looming release of Volto 18 tomorrow, the whole stable/pre-release paradigm gets tossed out. Instead the two Volto items will be renamed with "Volto 17" and "Volto 18".

ICYMI, we're migrating toward the Diataxis Framework for organization of documentation along two axes or four quadrants. Almost all of the current docs is a collection of how-to guides. "Backend" will be moved into separate guides, but mostly into the how-to guide, Admin Guide.

but this doesn't have to do anything with mockup or patternslib at all IMHO ... this is more a general explanation of how to create an addon for the backend with plonecli and should be placed somewhere else (maybe new sub-chapter "Create Addon" in the backend chapter ?) ... for mockup the subtemplate mockup_pattern is interesting when creating a new one.

Sorry, two "this"s and I am lost. I think your first "this" referred to Create a project with Classic UI (stable release), and the second "this" to this pull request Mockup and Patternslib. Assuming I guessed correctly, then first I will review this content, then we can determine where it should go, although I think @davisagli might have already figured it out for us before I could reply. 😁

[davisagli]

@stevepiercy No, @petschki was talking about the "get started" section of the file that's the focus of this PR (https://6.docs.plone.org/classic-ui/mockup.html#get-started). He's saying the general information about how to create an add-on using plonecli belongs in a separate section. I agree and I think the developer guide is a good place for that. (Can we merge the initial creation of the developer guide so that it's easier to work on new PRs that add things to it?)

We need to rename them all anyway, because with the looming release of Volto 18 tomorrow, the whole stable/pre-release paradigm gets tossed out. Instead the two Volto items will be renamed with "Volto 17" and "Volto 18".

@stevepiercy I think I've already taken care of that in #1746 in a way that will work after Volto 18 is released. Please take a look at that and give feedback before working on renaming them in a different way.

[petschki]

@stevepiercy sorry for the confusion and @davisagli thanks for clarifying 👍🏼

I was talking about the changes here #1734

[stevepiercy]

This is awesome! Thanks for the contribution. My review is my pushed commits, with a couple of noobie questions.

[stevepiercy]

Minor grammar tweaks. Otherwise LGTM! Thank you!