Skip to content

Commit 8142b96

Browse files
stevepiercystevepiercy
committed
Add Create a backend add-on section in the Developer guide.
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.
1 parent e46ff14 commit 8142b96

File tree

5 files changed

+106
-13
lines changed

5 files changed

+106
-13
lines changed

‎docs/developer-guide/create-a-backend-add-on.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "How to create a custom Plone distribution"
5+
"property=og:description": "How to create a custom Plone distribution"
6+
"property=og:title": "Create a Plone distribution"
7+
"keywords": "Plone 6, distribution, plone.distribution"
8+
---
9+
10+
(create-a-backend-add-on-label)=
11+
12+
# Create a backend add-on
13+
14+
This section explains how a developer can create an {term}`add-on` for the Plone backend.
15+
You will use a framework called {term}`GenericSetup`.
16+
17+
```{note}
18+
This section for Plone 6 is in the process of being written.
19+
Until it is complete, Plone 5 documentation is the authoritative source.
20+
{doc}`plone5:develop/addons/components/genericsetup` (Plone 5)
21+
```

‎docs/developer-guide/create-a-distribution.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@ For a conceptual guide, see {doc}`/conceptual-guides/distributions`.
1919
```
2020

2121

22-
## Create a backend add-on
22+
## Use a backend add-on
2323

24-
These instructions assume that you already have created a Plone backend add-on package,
25-
and now you want to add a distribution to it.
24+
These instructions assume that you have already {doc}`created a Plone backend add-on package <create-a-backend-add-on>`, and now you want to add a distribution to it.
2625

2726
A Plone distribution exists inside a Python package that can be installed by `pip`.
2827

‎docs/developer-guide/index.md

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,94 @@
11
---
22
myst:
33
html_meta:
4-
"description": "Plone developer guide"
5-
"property=og:description": "Plone developer guide"
6-
"property=og:title": "Developer guide"
7-
"keywords": "Plone 6, developer guide, development"
4+
"description": "Plone development guide"
5+
"property=og:description": "Plone development guide"
6+
"property=og:title": "Development guide"
7+
"keywords": "Plone 6, development guide, developer, development"
88
---
99

10-
# Developer guide
10+
# Development guide
11+
12+
```{note}
13+
This part of the documentation is under revision, consolidating documentation for development from its various locations into in one section.
14+
Until then, you can use the [search feature](https://6.docs.plone.org/search.html?q=development).
15+
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).
16+
```
1117

1218
This part of the documentation provides information for how to develop in Plone.
19+
This development guide points you, as a developer, to the appropriate resource.
20+
21+
22+
## Tests
23+
24+
Tests ensure that your project functions as expected, and that changes to the code base during development don't break anything.
25+
26+
27+
### Volto
28+
29+
- {doc}`Volto acceptance tests </volto/contributing/acceptance-tests>`
30+
- {doc}`Volto unit tests </volto/contributing/testing>`
31+
- {ref}`testing-the-add-on-label`
32+
33+
34+
### Classic UI
1335

1436
```{note}
15-
This part of the documentation is under construction.
16-
You can find documentation for development in various locations through the [search feature](https://6.docs.plone.org/search.html?q=development).
17-
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).
37+
Classic UI testing for Plone 6 is in the process of being written.
1838
```
1939

2040

41+
### Backend
42+
43+
```{note}
44+
Backend testing for Plone 6 is in the process of being written.
45+
Until it is complete, Plone 5 documentation is the authoritative source for writing tests for the Plone backend.
46+
```
47+
48+
- {doc}`Backend tests <plone5:develop/testing/index>` (Plone 5)
49+
50+
51+
## Create an add-on
52+
53+
- {doc}`create-a-backend-add-on`
54+
- {doc}`/volto/development/add-ons/create-an-add-on-18`
55+
56+
57+
## Create a Plone distribution
58+
59+
{doc}`create-a-distribution`
60+
61+
62+
## Create content types
63+
64+
- {doc}`/backend/content-types/creating-content-types`
65+
- {doc}`plone5:develop/plone/content/index` (Plone 5)
66+
67+
68+
## Register views
69+
70+
{doc}`plone5:develop/plone/views/index` (Plone 5)
71+
72+
73+
## Register API services
74+
75+
{doc}`backend/configuration-registry`
76+
77+
78+
## {term}`ZCA`
79+
% TODO: This is a mixture of conceptual and how-to guides. Move its parts where they belong and rewrite.
80+
{doc}`plone5:develop/addons/components/index` (Plone 5)
81+
82+
83+
## {term}`ZCML`
84+
% TODO: This is a mixture of conceptual and how-to guides. Move its parts where they belong and rewrite.
85+
{doc}`plone5:develop/addons/components/zcml` (Plone 5)
86+
87+
2188
```{toctree}
2289
:maxdepth: 2
90+
:hidden:
2391
92+
create-a-backend-add-on
2493
create-a-distribution
2594
```

‎docs/glossary.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Buildout
2525
[Buildout](https://github.com/buildout/buildout/) is a Python-based tool for building and assembling applications from multiple parts, based on a configuration file.
2626
It was the most common way of installing Plone 3, 4, and 5, and can still be used with Plone 6.
2727
28+
Usage of Buildout in Plone appears in various places in this documentation.
29+
For a history and extended usage of Buildout, you can refer to the Plone 4 Documentation's section on [Buildout](https://4.docs.plone.org/old-reference-manuals/buildout/).
30+
The Plone community authored this reference manual, as Buildout's own documentation is suboptimal.
31+
2832
CMS
2933
Content Management System
3034

‎docs/i18n-l10n/translating-text-strings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Information in the PO file headers is ignored.
5656

5757
[`i18ndude`](https://pypi.org/project/i18ndude/) should be used to create a script which searches particular packages for translation strings.
5858

59-
If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script `update.sh` inside your package and a script `update_locale` in your buildout to extract the messages from your code.
59+
If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script `update.sh` inside your package and a script `update_locale` in your {term}`buildout` to extract the messages from your code.
6060

6161
After running that script, a new `domain.pot` file will be created in your `locales` directory where all the messages will be saved.
6262

@@ -273,7 +273,7 @@ This script hooks into the release process and builds the MO files for you.
273273

274274
### Installing i18ndude
275275

276-
The recommended method is to have {term}`i18ndude` installed via your [buildout](https://www.buildout.org/en/latest/).
276+
The recommended method is to have {term}`i18ndude` installed via your buildout.
277277

278278
Add the following to your `buildout.cfg`:
279279

0 commit comments

Comments
 (0)