Skip to content

Commit c4f475e

Browse files
committed
Rewrite "Install Plone from its packages" to be streamlined.
Remove duplicated or obsolete content, replacing duplicated content with links to source material. Reorganize the remaining bits into a new supplementary page "Manage add-ons, packages, and processes". Add Make and cookiecutter-plone-starter to the Glossary. Remove now unused toggle style and JavaScript. Optionally style images similar to figures, with <img class="figure" ... >
1 parent 52c5f80 commit c4f475e

File tree

9 files changed

+537
-485
lines changed

9 files changed

+537
-485
lines changed

docs/_static/custom.css

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ img {
4747
}
4848

4949
figure img,
50+
img.figure,
5051
.figure img {
5152
box-shadow: 0 6px 24px 0 rgba(153, 153, 153, 0.3);
5253
}
@@ -126,22 +127,6 @@ div.section div.section div.section {
126127
margin-bottom: 1.5rem !important;
127128
}
128129

129-
.admonition.toggle .admonition-title {
130-
cursor: pointer;
131-
display: flex;
132-
}
133-
134-
.admonition.toggle .admonition-title::after {
135-
content: "\f105";
136-
font-weight: 900;
137-
font-family: "Font Awesome 5 Free";
138-
margin-left: auto;
139-
}
140-
141-
.admonition.toggle .admonition-title.open::after {
142-
content: "\f107";
143-
}
144-
145130
/* admonition todo */
146131
.admonition.admonition-todo,
147132
div.admonition.admonition-todo {

docs/_static/plone-home-page.png

41.3 KB
Loading

docs/_static/plone-login-page.png

58.4 KB
Loading

docs/_templates/page.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,6 @@
1111
if ($.trim($(".topbar-contents .bd-toc").html()) === "") {
1212
$(".topbar-contents .bd-toc").css("visibility", "hidden");
1313
}
14-
// Add toggle to exercise solutions (admonition with class 'toggle')
15-
$(".toggle > *").hide();
16-
$(".toggle .admonition-title").show();
17-
$(".toggle .admonition-title").click(function() {
18-
$(this).parent().children().not(".admonition-title").toggle(400);
19-
$(this).parent().children(".admonition-title").toggleClass("open");
20-
})
2114
});
2215
</script>
2316

docs/glossary.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ Cookiecutter
2828
A command-line utility that creates projects from cookiecutters (project templates), for example, creating a Python package project from a Python package project template.
2929
[See Cookiecutter's documentation](https://cookiecutter.readthedocs.io/en/stable/).
3030
31+
cookiecutter-plone-starter
32+
[cookiecutter-plone-starter](https://github.com/collective/cookiecutter-plone-starter/) is a framework for jumpstarting Plone 6 projects quickly.
33+
3134
cookiecutter-zope-instance
3235
[cookiecutter-zope-instance](https://github.com/plone/cookiecutter-zope-instance) is a cookiecutter template to create a full and complex configuration of a Zope WSGI instance.
3336
@@ -440,4 +443,11 @@ ZODB
440443
441444
Zope
442445
[Zope](https://zope.readthedocs.io/en/latest/) is a Python-based application server for building secure and highly scalable web applications.
446+
447+
Make
448+
make
449+
[GNU Make](https://www.gnu.org/software/make/) is a tool which controls the generation of executables and other non-source files of a program from the program's source files.
450+
451+
Make gets its knowledge of how to build your program from a file called the _makefile_, which lists each of the non-source files and how to compute it from other files.
452+
When you write a program, you should write a makefile for it, so that it is possible to use Make to build and install the program.
443453
```

docs/install/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,5 @@ System requirements depend upon your choice of installation method.
102102
containers/index
103103
install-from-packages
104104
install-backend-from-packages-step-by-step
105+
manage-add-ons-packages
105106
```

docs/install/install-backend-from-packages-step-by-step.md

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,10 @@ myst:
1212

1313
# Install Plone backend from its packages – step-by-step
1414

15-
For system requirements and pre-requisites for the installation see {ref}`install-source-system-requirements-label`.
15+
For system requirements and pre-requisites for the installation see {ref}`install-packages-system-requirements-label`.
1616

1717
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxdev`, and other developer tools.
1818

19-
```{note}
20-
There will be one single cookiecutter template to install both backend and frontend from its packages.
21-
You will find the instructions on {ref}`install-source-installation-jump-label`.
22-
That chapter is for you if you want to develop and want to jump in with all steps prepared by an overall cookiecutter.
23-
The subsequent sections explain the installation of the backend step-by-step.
24-
You will learn the details of the installation included in the future overall cookiecutter.
25-
```
26-
2719

2820
(install-backend-from-packages-installation-steps-label)=
2921

@@ -43,47 +35,12 @@ Update Python package management tools.
4335
pip install -U pip wheel
4436
```
4537

46-
````{admonition} packages tree
47-
:class: margin toggle
48-
The Plone packages and dependencies are installed in trees.
49-
50-
```
51-
venv/lib/python3.x/site-packages
52-
53-
54-
├── plone
55-
│ ├── …
56-
│ ├── app/
57-
│    ├── caching/
58-
│    ├── content/
59-
│    └── …
60-
61-
├── zope/
62-
│ ├── …
63-
```
64-
````
65-
6638
Install Plone 6 with constrained requirements using `pip`.
6739

6840
```shell
6941
pip install Plone -c https://dist.plone.org/release/{PLONE_BACKEND_VERSION}/constraints.txt
7042
```
7143

72-
:::{admonition} <span>`mkwsgiinstance` creates a home with a minimal configuration for a Zope instance.</span>
73-
:class: margin toggle
74-
75-
```
76-
┌── etc/
77-
│ ├── site.zcml
78-
│ ├── zope.conf
79-
│ └── zope.ini
80-
├── inituser
81-
└── var/
82-
├── cache/
83-
├── log/
84-
└── REAMDME.txt/
85-
```
86-
:::
8744

8845
(install-backend-from-packages-step-by-step-mkwsgiinstance)=
8946

0 commit comments

Comments
 (0)