-
-
Notifications
You must be signed in to change notification settings - Fork 154
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. #1757
Open
stevepiercy
wants to merge
6
commits into
6.0
Choose a base branch
from
dev-guide-create-a-backend-add-on
base: 6.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
091a89a
Add Create a backend add-on section in the Developer guide.
stevepiercy a766f5a
- Update meta information
stevepiercy d8e135c
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy ed9c4af
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy 13b85f7
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy 0f7a455
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "How to create a backend add-on" | ||
"property=og:description": "How to create a backend add-on" | ||
"property=og:title": "Create a backend add-on" | ||
"keywords": "Plone 6, backend, add-on" | ||
--- | ||
|
||
(create-a-backend-add-on-label)= | ||
|
||
# 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`. | ||
|
||
```{note} | ||
This section for Plone 6 is in the process of being written. | ||
Until it is complete, Plone 5 documentation is the authoritative source. | ||
{doc}`plone5:develop/addons/components/genericsetup` (Plone 5) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,94 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "Plone developer guide" | ||
"property=og:description": "Plone developer guide" | ||
"property=og:title": "Developer guide" | ||
"keywords": "Plone 6, developer guide, development" | ||
"description": "Plone development guide" | ||
"property=og:description": "Plone development guide" | ||
"property=og:title": "Development guide" | ||
"keywords": "Plone 6, development guide, developer, development" | ||
--- | ||
|
||
# Developer guide | ||
# Development guide | ||
|
||
```{note} | ||
This part of the documentation is under revision, consolidating documentation for development from its various locations into in one section. | ||
Until then, you can use the [search feature](https://6.docs.plone.org/search.html?q=development). | ||
You can also help with this effort, even if it is to report that something is missing, by [creating an issue](https://github.com/plone/documentation/issues/new?assignees=&labels=&projects=&template=new-issue-form.yml). | ||
``` | ||
|
||
This part of the documentation provides information for how to develop in Plone. | ||
This development guide points you, as a developer, to the appropriate resource. | ||
|
||
|
||
## Tests | ||
|
||
Tests ensure that your project functions as expected, and that changes to the code base during development don't break anything. | ||
|
||
|
||
### Volto | ||
|
||
- {doc}`Volto acceptance tests </volto/contributing/acceptance-tests>` | ||
- {doc}`Volto unit tests </volto/contributing/testing>` | ||
- {ref}`testing-the-add-on-label` | ||
|
||
|
||
### Classic UI | ||
|
||
```{note} | ||
This part of the documentation is under construction. | ||
You can find documentation for development in various locations through the [search feature](https://6.docs.plone.org/search.html?q=development). | ||
You can help consolidate all of development documentation here, even if it is to let us know what is missing, by [creating an issue](https://github.com/plone/documentation/issues/new?assignees=&labels=&projects=&template=new-issue-form.yml). | ||
Classic UI testing for Plone 6 is in the process of being written. | ||
``` | ||
|
||
|
||
### Backend | ||
|
||
```{note} | ||
Backend testing for Plone 6 is in the process of being written. | ||
Until it is complete, Plone 5 documentation is the authoritative source for writing tests for the Plone backend. | ||
``` | ||
|
||
- {doc}`Backend tests <plone5:develop/testing/index>` (Plone 5) | ||
|
||
|
||
## Create an add-on | ||
|
||
- {doc}`create-a-backend-add-on` | ||
- {doc}`/volto/development/add-ons/create-an-add-on-18` | ||
|
||
|
||
## Create a Plone distribution | ||
|
||
{doc}`create-a-distribution` | ||
|
||
|
||
## Create content types | ||
|
||
- {doc}`/backend/content-types/creating-content-types` | ||
- {doc}`plone5:develop/plone/content/index` (Plone 5) | ||
|
||
|
||
## Register views | ||
|
||
{doc}`plone5:develop/plone/views/index` (Plone 5) | ||
|
||
|
||
## Register API services | ||
|
||
{doc}`backend/configuration-registry` | ||
|
||
|
||
## {term}`ZCA` | ||
% TODO: This is a mixture of conceptual and how-to guides. Move its parts where they belong and rewrite. | ||
{doc}`plone5:develop/addons/components/index` (Plone 5) | ||
|
||
|
||
## {term}`ZCML` | ||
% TODO: This is a mixture of conceptual and how-to guides. Move its parts where they belong and rewrite. | ||
{doc}`plone5:develop/addons/components/zcml` (Plone 5) | ||
|
||
|
||
```{toctree} | ||
:maxdepth: 2 | ||
:hidden: | ||
|
||
create-a-backend-add-on | ||
create-a-distribution | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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".