You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/plone-deployment/deploy.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Plone backend
25
25
Postgres 14 database
26
26
: Handles data persistence.
27
27
28
-
You can find this stack at {file}`devops/stacks/ploneconf2025-<your-github-username>.tangrama.com.br.yml`. It's modular, allowing integration of additional services, such as {term}`Varnish`, `Solr`, or `ElasticSearch`.
28
+
You can find this stack at {file}`devops/stacks/pybr25-<your-github-username>.tangrama.com.br.yml`. It's modular, allowing integration of additional services, such as {term}`Varnish`, `Solr`, or `ElasticSearch`.
29
29
30
30
```{seealso}
31
31
[Traefik Proxy with HTTPS](https://dockerswarm.rocks/traefik/)
@@ -69,7 +69,7 @@ Utilize the {file}`Makefile` at {file}`devops/Makefile` for manual deployment.
69
69
70
70
### Deploy the stack
71
71
72
-
Execute the following command from your project's {file}`devops/ansible` directory to deploy the stack defined in {file}`devops/stacks/ploneconf2025-<your-github-username>.tangrama.com.br.yml` to the remote server.
72
+
Execute the following command from your project's {file}`devops/ansible` directory to deploy the stack defined in {file}`devops/stacks/pybr25-<your-github-username>.tangrama.com.br.yml` to the remote server.
73
73
74
74
```shell
75
75
uv run ansible-playbook playbooks/deploy.yml --tags project
@@ -80,13 +80,13 @@ uv run ansible-playbook playbooks/deploy.yml --tags project
80
80
To check the status of all services in your stack, access the remote server:
Copy file name to clipboardExpand all lines: docs/plone-deployment/project-edit.md
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ myst:
9
9
10
10
# Customize your project
11
11
12
-
[Please fill this form](https://forms.gle/npDRESAud4ntDnUz7).
12
+
[Please fill this form](https://forms.gle/ihYVZxmnypwBnZk39).
13
13
14
14
Plone offers a wealth of features right out of the box. You can extend these capabilities using {term}`TTW` modifications, such as creating new content types, altering the default workflow, or configuring the top-level navigation. For additional functionalities not covered by Plone, you can either develop your own solutions or integrate existing add-ons.
15
15
@@ -19,11 +19,11 @@ A Plone project is composed by, at least, a backend Python package and a fronten
19
19
20
20
The packages for this training are:
21
21
22
-
`ploneconf2025.core`
23
-
: Package metadata located at {file}`backend/pyproject.toml` and code at {file}`backend/src/ploneconf2025/core`.
22
+
`pybr25.core`
23
+
: Package metadata located at {file}`backend/pyproject.toml` and code at {file}`backend/src/pybr25/core`.
24
24
25
-
`volto-ploneconf2025-core`
26
-
: Package metadata located at {file}`frontend/packages/volto-ploneconf2025-core/package.json` and code at {file}`frontend/packages/volto-ploneconf2025-core/src`.
25
+
`volto-pybr25-core`
26
+
: Package metadata located at {file}`frontend/packages/volto-pybr25-core/package.json` and code at {file}`frontend/packages/volto-pybr25-core/src`.
27
27
28
28
## Integrate add-ons
29
29
@@ -58,11 +58,11 @@ dependencies = [
58
58
]
59
59
```
60
60
61
-
Then we tell Zope to load the add-on run-time configurations by editing {file}`backend/src/ploneconf2025/core/dependencies.zcml` and append `kitconcept.voltolighttheme`.
61
+
Then we tell Zope to load the add-on run-time configurations by editing {file}`backend/src/pybr25/core/dependencies.zcml` and append `kitconcept.voltolighttheme`.
@@ -73,11 +73,11 @@ Then we tell Zope to load the add-on run-time configurations by editing {file}`b
73
73
</configure>
74
74
```
75
75
76
-
And, if we want to have this add-on installed when we create a new website, edit {file}`backend/src/ploneconf2025/core/profiles/default/metadata.xml` and append `profile-kitconcept.voltolighttheme:default`.
76
+
And, if we want to have this add-on installed when we create a new website, edit {file}`backend/src/pybr25/core/profiles/default/metadata.xml` and append `profile-kitconcept.voltolighttheme:default`.
@@ -92,25 +92,27 @@ And, if we want to have this add-on installed when we create a new website, edit
92
92
```
93
93
94
94
95
-
#### Frontend: incorporate a new dependency
95
+
#### Frontend: incorporate two new dependencies
96
96
97
-
Edit {file}`frontend/packages/volto-ploneconf2025/package.json` and append `@kitconcept/volto-light-theme` to the `addons` and `dependencies` sections, as shown below:
97
+
Edit {file}`frontend/packages/volto-pybr25/package.json`, add `@kitconcept/volto-light-theme` and `@plone-collective/volto-image-editor` to the `addons` and `dependencies` sections, as shown below:
Also, edit the {file}`frontend/volto.config.js` and change the theme to be `@kitconcept/volto-light-theme`:
111
113
112
114
```js
113
-
constaddons= ['volto-ploneconf2025'];
115
+
constaddons= ['volto-pybr25'];
114
116
consttheme='@kitconcept/volto-light-theme';
115
117
116
118
module.exports= {
@@ -144,7 +146,7 @@ git push
144
146
145
147
To ensure the behaviors manually applied to the Plone Site persist after the site is re-created, we need to add them via Generic Setup.
146
148
147
-
Create a new file {file}`backend/src/ploneconf2025/core/profiles/default/types/Plone_Site.xml` with the following content:
149
+
Create a new file {file}`backend/src/pybr25/core/profiles/default/types/Plone_Site.xml` with the following content:
148
150
149
151
```xml
150
152
<?xml version="1.0" encoding="utf-8"?>
@@ -178,7 +180,7 @@ cd backend
178
180
make update-example-content
179
181
```
180
182
181
-
Now, if you run `git status` you should see changes to files under {file}`backend/src/ploneconf2025/core/setuphandlers/examplecontent`. This is the location where `plone.exportimport` will look for the content to be for your Plone site upon creation.
183
+
Now, if you run `git status` you should see changes to files under {file}`backend/src/pybr25/core/setuphandlers/examplecontent`. This is the location where `plone.exportimport` will look for the content to be for your Plone site upon creation.
182
184
183
185
Now we are going to add these changes to our repository by running:
[7/20] Should we use prerelease versions? (No): Yes
60
60
[8/20] Plone Version (6.1.3):
61
61
[9/20] Volto Version (19.0.0-alpha.6):
62
-
[10/20] Python Package Name (ploneconf2025): ploneconf2025.core
63
-
[11/20] Volto Addon Name (volto-ploneconf2025-core):
62
+
[10/20] Python Package Name (pybr25): pybr25.core
63
+
[11/20] Volto Addon Name (volto-pybr25-core):
64
64
[12/20] Language
65
65
1 - English
66
66
2 - Deutsch
@@ -72,7 +72,7 @@ An example interaction with the `Cookieplone` wizard is shown below:
72
72
8 - Svenska
73
73
Choose from [1/2/3/4/5/6/7/8] (1):
74
74
[13/20] GitHub or GitLab username or organization slug from URL (collective): <your-github-username>
75
-
[14/20] URL to the repository (https://github.com/<your-github-username>/ploneconf2025):
75
+
[14/20] URL to the repository (https://github.com/<your-github-username>/pybr25):
76
76
[15/20] Container Registry
77
77
1 - GitHub Container Registry
78
78
2 - Docker Hub
@@ -104,7 +104,7 @@ An example interaction with the `Cookieplone` wizard is shown below:
104
104
Navigate to your project directory:
105
105
106
106
```shell
107
-
cdploneconf2025
107
+
cdpybr25
108
108
```
109
109
110
110
### Understanding the code base
@@ -131,12 +131,12 @@ Install both the Plone backend and frontend with:
131
131
make install
132
132
```
133
133
134
-
This process will take a few minutes. Once completed, a success message will appear. Both the frontend and backend in their respective directories will be built.
134
+
This process will take a few minutes. Once completed, a success message will appear. Both the frontend and backend in their respective directories will be built.
135
135
136
136
For the frontend, the Node.js version will be used that you activated in the previous chapter with `nvm use --lts`. For the backend Python version, uv will check a `requires-python` key in the {file}`pyproject.toml` file.
137
137
138
138
Putting too specific Node.js and Python versions in the scaffolded project setup can cause other issues.
139
-
That's why the project generator gives hints for versions with ranges or `LTS`. But it is your own choice and responsibility to check for the correct major versions of both programming languages are active and available before you run `make install` in the project root or frontend and backend subdirectories for the first time.
139
+
That's why the project generator gives hints for versions with ranges or `LTS`. But it is your own choice and responsibility to check for the correct major versions of both programming languages are active and available before you run `make install` in the project root or frontend and backend subdirectories for the first time.
140
140
141
141
### Code formatting and i18n
142
142
@@ -167,7 +167,7 @@ Visit [GitHub](https://github.com) and log in.
167
167
168
168
Click the `+` icon in the upper right corner, select `New repository`, and fill in the details:
Copy file name to clipboardExpand all lines: docs/plone-deployment/project-start.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ Ensure port 80 is free, then initiate the stack with:
84
84
make stack-start
85
85
```
86
86
87
-
Docker will download necessary images, build Frontend and Backend images, and initiate all services. Upon completion, a message prompts you to visit [http://ploneconf2025.localhost](http://ploneconf2025.localhost).
87
+
Docker will download necessary images, build Frontend and Backend images, and initiate all services. Upon completion, a message prompts you to visit [http://pybr25.localhost](http://pybr25.localhost).
88
88
89
89
### Checking the Stack Status
90
90
@@ -108,12 +108,12 @@ Re-run `make stack-status`, and both backend and frontend should now display a *
108
108
109
109
### Accessing the site
110
110
111
-
Your website is accessible at http://ploneconf2025.localhost.
111
+
Your website is accessible at http://pybr25.localhost.
112
112
113
113
```{figure} _static/start_stack_localhost.png
114
-
:alt: Accessing the site at `http://ploneconf2025.localhost`
114
+
:alt: Accessing the site at `http://pybr25.localhost`
115
115
116
-
Accessing the site at `http://ploneconf2025.localhost`
0 commit comments