Skip to content

Commit 260869d

Browse files
fredvdstevepiercy
andauthored
Apply suggestions from code review
Co-authored-by: Steve Piercy <[email protected]>
1 parent 8b89f24 commit 260869d

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/overview/index.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -75,22 +75,22 @@ Plone is a content management platform with its backend written in Python.
7575
It is built on top of the open source Zope web application server and development system.
7676
Plone is making use of the pluggable Zope Component Architecture (ZCA) to provide a highly modular and extensible system.
7777
Throughout its history, Plone has used server-side rendering to generate HTML-based content, with advanced resource management features for adding and bundling CSS and JavaScript.
78-
Additionally, Plone's use of the ZCA makes it easy to extend and custosize, allowing users to create unique, feature-rich websites that are tailored to their specific needs.
78+
Additionally, Plone's use of the ZCA makes it easy to extend and customize, allowing users to create unique, feature rich websites that are tailored to their specific needs.
7979

8080
With the release of Plone 6, you now have the option to choose from two different out-of-the-box supported configurations when setting up a new Plone website.
81-
The Python-based backend server in Plone alone can still be used to render content server-side and deliver HTML to the browser, a setup that is referred to in the Plone documentation as "Classic UI".
82-
This configuration has been supported by Plone since its initial release and is still available in the latest versions of the platform.
83-
For container-based deployment, only the plone-backend image is required, or a derivative image with customisations added.
81+
The Python-based backend server in Plone can still be used alone to render content server-side and deliver HTML to the browser, a setup that is referred to in the Plone documentation as "Classic UI".
82+
This configuration has been supported by Plone since its initial release and is still available in the latest version of the platform.
83+
For container-based deployment, only the `plone-backend` image is required, or a derivative image with customizations added.
8484

85-
The default and advised configuration for new websites in Plone is to use our new React Based javascript frontend called 'Volto'.
86-
For this setup you still need to run the Python based backend server, but with the REST API enabled and an updated configuration profile.
87-
In addition a separate NodeJS based frontend server will serve the javascript frontend resources and provide SSR with hydration.
88-
To deploy this setup using containers you will need the plone-frontend image of the frontend server.
85+
The default and recommended configuration for new websites in Plone is the new React-based JavaScript frontend called "Volto".
86+
For this setup you still need to run the Python-based backend server, as well as enable the REST API, and update the configuration profile.
87+
In addition a separate NodeJS based frontend server will serve the JavaScript frontend resources and provide SSR with hydration.
88+
To deploy this setup using containers, you will need the `plone-frontend` image for the frontend server.
8989

90-
Plone 6 is the version Plone where we support two programming language stacks, one for Python and Javascript.
90+
Beginning with Plone 6, we now support two programming language stacks, one each for Python and JavaScript.
9191
The documentation has been rewritten, but for this first release you will find some repetition of concepts in the documentation structure.
92-
For example for the development setup and information on deployment options.
93-
It will take some time before we find and can implement the best structure to explain these new possibilities and expansion of Plone its capabilities.
92+
See, for example, the development setup and information on deployment options.
93+
It will take some time until we find and can implement the best structure to explain these new possibilities and the expansion of Plone's capabilities.
9494

9595
```{seealso}
9696
https://training.plone.org/mastering-plone/what_is_plone.html
@@ -100,9 +100,9 @@ https://training.plone.org/mastering-plone/what_is_plone.html
100100
(overview-5-label)=
101101
## Deployment
102102

103-
To run a public Plone website in production, you will also need to configure and run a reverse proxy (or ingress), arrange for SSL certificates (either from Let's Encrypt or manually), guarantee persistence of the content database and arrange for backups.
104-
This is the domain of sysadmins and modern devops.
105-
Our documentation contains setup examples for these services but requires also generic experience and knowledge of these domains.
103+
To run a public Plone website in production, you will also need to configure and run a reverse proxy (or ingress), arrange for SSL certificates (either from Let's Encrypt or manually), guarantee persistence of the content database, and arrange backups.
104+
This is the domain of systems administrators and modern developer-operations professionals.
105+
Our documentation contains setup examples for these services, yet requires that the reader have some generic experience and knowledge of these domains.
106106

107107

108108
(overview-6-label)=
@@ -111,12 +111,12 @@ Our documentation contains setup examples for these services but requires also g
111111
One of the key benefits of the new React-based frontend for Plone 6 is that you can now customize and theme Plone extensively using HTML, CSS, and JavaScript using up-to-date frontend technologies without having having to set up a local Python development environment.
112112
The Plone backend can be run on a local developer machine in a container.
113113

114-
Basic familiarity with programming in Python and managing Python modules/packages using virtualenv and pip is required to work on the backend code.
115-
We use virtualenv and mxdev to manage the source installation of packages in Plone 6.
114+
Basic familiarity with programming in Python and managing Python modules and packages using `virtualenv` and `pip` is required to work on the backend code.
115+
We use `virtualenv` and {term}`mxdev` to manage the source installation of packages in Plone 6.
116116

117-
Similarly, to develop for the new React frontend, you need to have some experience with setting up NodeJS, using a tool like NVM (Node Version Manager) to isolate your setup, Yarn and React.
117+
Similarly, to develop for the new React frontend, you need to have some experience with setting up NodeJS, using a tool like NVM (Node Version Manager) to isolate your setup, and familiarity with {term}`Yarn` and {term}`React`.
118118

119-
If you are looking for more study material on these technologies and the documentation is too dense, see and follow one or more [Plone Trainings](https://training.plone.org).
119+
If you are looking for more study material on these technologies beyond the documentation, see and follow one or more [Plone Trainings](https://training.plone.org).
120120
Our trainings are more verbose and contain extra clarification and examples.
121121

122122

0 commit comments

Comments
 (0)