Skip to content

Commit 44101ef

Browse files
committed
Update overview. remove history page for now.
1 parent 86ce31b commit 44101ef

File tree

2 files changed

+21
-70
lines changed

2 files changed

+21
-70
lines changed

docs/overview/history.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/overview/index.md

Lines changed: 21 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,8 @@ myst:
99

1010
(overview-label)=
1111

12-
# Overview
13-
14-
````{todo}
15-
This page needs content.
16-
```{seealso}
17-
[Issue #1352](https://github.com/plone/documentation/issues/1352)
18-
```
19-
````
2012

21-
(overview-2-label)=
22-
23-
## Overview
13+
# Overview
2414

2515
Plone is a mature, secure, and user-friendly content management system (CMS).
2616
Plone was first released to the public on October 4, 2001.
@@ -37,9 +27,6 @@ Plone works as a:
3727
- React-based frontend for editing and viewing content, backed by a server with a REST API.
3828
- Headless CMS server with a REST API, allowing a developer to build a custom frontend with their chosen technology.
3929

40-
41-
42-
4330
(overview-3-label)=
4431

4532
## Key benefits
@@ -78,63 +65,55 @@ Plone is easy to set up compared to other CMS'es in its category, extremely flex
7865

7966
(overview-4-label)=
8067

81-
## High Level Overview
68+
## High Level Overview for Developers
8269

8370
Plone is a content management platform with its backend written in Python. The backend builds upon Zope, an open source web
84-
application server and development system, and thus on the pluggable Zope Component Architecture (ZCA). The frontend has up until now
71+
application server and development system, and thus on the pluggable Zope Component Architecture (ZCA). The frontend has up until version 6
8572
served HTML based content, with advanced resource management on the server to add and bundle CSS and javascript.
8673

8774
With the release of Plone 6 there are now two out of the box supported configurations possible for a new Plone website.
8875

8976
You can still use the Python based backend server to render the content server side and deliver html to the browser.
9077
This setup is referred to in the documentation as 'Classic UI' and has been supported by Plone since its release.
91-
For container based deployment you only need the plone-backend image, or a derivation with your customisations added.
78+
For container based deployment you only need the plone-backend image, or a derivation with your customisations added.
79+
In the documentation
9280

9381
The default and advised configuration for new websites in Plone is to use our new React Based javascript frontend called 'Volto'.
94-
For this setup you will still need to run the Python based backend server, but with the REST API enabled and an updated configuration profile.
82+
For this setup you still need to run the Python based backend server, but with the REST API enabled and an updated configuration profile.
9583
In addition a separate NodeJS based frontend server will serve the javascript frontend resources and provide SSR with hydration.
9684
To deploy this setup using containers you will need the plone-frontend image of the frontend server.
9785

98-
This is the first release of Plone where the community has to work in and support 2 language and development stacks.
86+
This is the first release of Plone where we support two programming language stacks, one for Python and Javascript.
9987
The documentation has been rewritten, but for this first release you will find some repetition of concepts in the documentation structure.
100-
For example for deployment or development setup.
101-
It will take some time before we will find the best structure to explain these new possibilities and expansion of Plone its capabilities.
88+
For example for the development setup and information on deployment options.
89+
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.
10290

10391

10492
(overview-5-label)=
93+
## Deployment
10594

106-
### Traditional server side rendered HTML pages
95+
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 Lets Encrypt or manually), check persistenct of the content database and arrange for backups. This is the domain
96+
of sysadmins and modern devops. Our documentation contains setup examples for these services but requires also experience and knowledge.
10797

10898

10999
(overview-6-label)=
100+
## Good to know / What to know
110101

111-
### Headless CMS with JavaScript frontend through a REST API
112-
113-
114-
(overview-7-label)=
102+
One of the key benefits of the new React based frontend for Plone 6 is that you can now customise and theme Plone extensively using HTML and Javascript using up to date frontend technologies without having having to set up a local Python development environment.
103+
The Plone backend can be run on a local developer machine in a container.
115104

116-
### Explain frontend-backend terms
105+
Basic familiarity with programming in Python and managing Python modules/packages using virtualenv and pip is required to work on the backend code.
106+
We use virtualenv and mxdev to manage the source installation of packages in Plone 6.
117107

108+
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.
118109

119-
(overview-8-label)=
120-
121-
### Security
122-
123-
124-
(overview-9-label)=
125-
126-
### Accessibility (a11y)
127-
128-
129-
(overview-10-label)=
130-
131-
### Internationalization (i18n)
132-
110+
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).
111+
Our trainings are more verbose and contain extra clarification and examples.
133112

134113

135114
```{toctree}
136115
:maxdepth: 2
137116
:hidden:
138117
139-
history
118+
140119
```

0 commit comments

Comments
 (0)