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

Add Create a backend add-on section in the Developer guide with GenericSetup #1757

Open
wants to merge 7 commits into
base: 6.0
Choose a base branch
from

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Nov 6, 2024

See #1748 (comment)

Closes #1754.

Ping @petschki to take it from here.


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

Ping @petschki
- Enhance the Development Guide index
- Update the term Buildout in the Glossary to point to dusty old, yet useful, docs in Plone 4.

(cherry picked from commit 8142b96)
- Add term reference for Buildout
# Create a backend add-on

This section explains how a developer can create an {term}`add-on` for the Plone backend.
You will use a framework called {term}`GenericSetup` and a tool called {term}`Buildout`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite get your vision for this section yet.

Most of the documentation that can be written about how to create a backend add-on will be relevant regardless of how Plone was installed, and also regardless of whether the add-on was created from a Cookieplone template, bobtemplates.plone, or by hand.

So mentioning buildout here is off topic.

And learning about GenericSetup is a piece of what goes into creating an add-on, but it's certainly not the only or the most important piece.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created this file to jump start something for @petschki to work on. I have no vision about this whatsoever. If the snippets aren't needed, they can be tossed out.

I moved the snippets here from another document that had them as headings in a how-to guide, instead of in a conceptual guide. IOW no one does "How to Buildout and GenericSetup".

@stevepiercy stevepiercy changed the title Add Create a backend add-on section in the Developer guide. Add Create a backend add-on section in the Developer guide with GenericSetup Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Status: Todo
Development

Successfully merging this pull request may close these issues.

Port GenericSetup docs
2 participants