Skip to content

Commit 489e82b

Browse files
Add Standardize Python project configuration developer guide (#1830)
* Add Standardize project configuration * Add Standardize Python project configuration developer guide - Closes #1827 * - s/`meta`/`plone/meta` - add exclusions * Remove activate step, adjust commands to include path to binaries * Reword monorepo definition * Update docs/developer-guide/standardize-python-project-configuration.md Co-authored-by: Maurits van Rees <[email protected]> * Update tips submodules/plone.restapi submodules/volto * - Remove basic usage - Change script to command * Remove duplicate content * Fix see also --------- Co-authored-by: Maurits van Rees <[email protected]>
1 parent 105395c commit 489e82b

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/developer-guide/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ You can help consolidate all of development documentation here, even if it is to
2222
:maxdepth: 2
2323
2424
create-a-distribution
25+
standardize-python-project-configuration
2526
```
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Standardize project configuration in Plone with plone/meta"
5+
"property=og:description": "Standardize project configuration in Plone with plone/meta"
6+
"property=og:title": "Standardize project configuration in Plone with plone/meta"
7+
"keywords": "Plone 6, standardize, project, configuration, development, plone/meta"
8+
---
9+
10+
# Standardize Python project configuration
11+
12+
This part of the documentation describes how to standardize Python project configuration in Plone.
13+
It does not cover the following.
14+
15+
- Volto or any other JavaScript-based project, which has its own ecosystem.
16+
- Monorepo projects with backend and frontend code bases, such as those created by [Cookieplone](https://github.com/plone/cookieplone).
17+
Repositories must have a single Python package at the top level.
18+
- Projects that support multiple versions of Plone in the same branch.
19+
20+
Plone consists of hundreds of projects.
21+
To lessen the effort of configuring a new project in the Plone GitHub organization, and to keep these projects current with latest configuration practices, the Plone community agreed upon a trusted set of configuration items.
22+
The Plone community manages these configuration items using the [`plone/meta`](https://github.com/plone/meta) project.
23+
24+
You can follow these practices in your own projects, or suggest new or alternative configuration items through the `plone/meta` repository, sharing them with the rest of the Plone community.
25+
26+
```{seealso}
27+
See also [`plone/meta` documentation](https://github.com/plone/meta?tab=readme-ov-file#setup) for setup and usage.
28+
```

0 commit comments

Comments
 (0)