Skip to content

Commit d9b010a

Browse files
committed
Merge branch '6.0' of https://github.com/plone/documentation into 6.0
# Conflicts: # submodules/plone.restapi
2 parents 38e17ce + 41696ab commit d9b010a

40 files changed

+1046
-246
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"[markdown]": {
3+
"editor.formatOnSave": false
4+
}
5+
}

docs/_inc/_continuous-integration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Plone project repositories use {term}`continuous integration` (CI) to run tests, ensure code quality, or provide previews for every contribution.
2+
Plone uses GitHub workflows, Jenkins, Cypress, Read the Docs, and other services for CI.
3+
All of a project's CI jobs must pass before a contribution may be accepted.
4+
5+
```{seealso}
6+
{doc}`/contributing/core/continuous-integration`
7+
```

docs/_inc/_hardware-requirements.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The hardware requirements below give a rough estimate of the minimum hardware setup needed for a Plone server.
2+
3+
A single Plone installation is able to run many Plone sites.
4+
5+
- Installation of the Plone backend and Classic UI frontend requires a minimum of 256 MB of RAM and 2GB of disk swap space.
6+
- Installation of the Volto frontend requires a minimum of 2GB of RAM.
7+
- After installation, running Plone requires a minimum of 256 MB RAM and 512 MB of disk swap space per Plone site.
8+
2 GB or more RAM per Plone site is recommended.
9+
- Minimum 512 MB hard disk space is required.
10+
40 GB or more hard disk space is recommended.
11+
12+
13+
````{warning}
14+
{term}`Add-on` products and caching solutions may also increase RAM and disk swap space requirements.
15+
To avoid RAM and disk swap limitations, we recommend either temporarily resizing your remote machine to accommodate the build, or build your images locally and upload them to an image store, such as [Docker Hub](https://hub.docker.com/) or [GitHub Actions](https://github.com/features/actions).
16+
```{seealso}
17+
[How much RAM is required to build a Volto front end?](https://community.plone.org/t/how-much-ram-is-required-to-build-a-volto-front-end/17949) and [Dealing with heap exhaustion while building Volto 17 on limited-RAM host](https://community.plone.org/t/dealing-with-heap-exhaustion-while-building-volto-17-on-limited-ram-host/18078).
18+
```
19+
````

docs/_inc/_install-pillow.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
``````{note}
2+
After generating a project, then running `make install`, if you see an error message `ERROR: Failed building wheel for Pillow`, then you need to install Pillow's dependencies.
3+
4+
`````{tab-set}
5+
6+
````{tab-item} macOS
7+
```shell
8+
brew install zlib libjpeg
9+
```
10+
````
11+
12+
````{tab-item} Linux
13+
```shell
14+
apt-get zlib libjpeg
15+
```
16+
````
17+
`````
18+
19+
You will then need to run `make install` again.
20+
21+
```{seealso}
22+
See also the Pillow documentation [External Libraries](https://pillow.readthedocs.io/en/latest/installation/building-from-source.html#external-libraries) for additional libraries that you might need.
23+
```
24+
``````

docs/_inc/_install-python.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Installing Python is beyond the scope of this documentation.
2+
However, it is recommended to use a Python version manager, {term}`pyenv`, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
3+
% TODO: uncomment this line after upgrading to plone-sphinx-theme and latest Sphinx which supports replacements inside includes.
4+
% Plone requires Python version {SUPPORTED_PYTHON_VERSIONS}.
5+
6+
Plone requires Python version 3.8, 3.9, 3.10, 3.11, or 3.12.
Loading
54.5 KB
Loading
89.5 KB
Loading

docs/_static/plone-home-page.png

79.2 KB
Loading

docs/_static/plone-login-page.png

-342 Bytes
Loading

0 commit comments

Comments
 (0)