Skip to content

Commit 87dcb50

Browse files
committed
Add new section to import caching profiles and reference from rulesets-and-caching-operations.md
Refs: plone#1449 (comment)
1 parent e2c0c95 commit 87dcb50

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed
83.1 KB
Loading

docs/deployment/caching/enable.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,51 @@ Even though cache support is available in Plone, it is **not enabled by default*
1919
It is highly recommended to configure caching for every new Plone site in production.
2020

2121

22+
(import-a-caching-profile-label)=
23+
24+
## Import a caching profile
25+
26+
Importing a caching profile is currently only supported in the Classic UI.
27+
28+
We recommend that you import a caching profile to start.
29+
You can always modify the profile later as needed.
30+
31+
As an administrator, navigate to {guilabel}`Site Setup`.
32+
Under the {guilabel}`Advanced` heading or navigation item, select the <img alt="Caching" src="/_static/caching/icon-caching.svg" class="inline"> {guilabel}`Caching` control panel.
33+
34+
````{card}
35+
```{image} /_static/caching/caching-disabled.png
36+
:alt: Caching Control Panel with caching disabled
37+
:target: /_static/caching/caching-disabled.png
38+
```
39+
+++
40+
_Caching Control Panel with caching disabled_
41+
````
42+
43+
From here click either the helpful link in the blue information box {guilabel}`importing a preconfigured set of caching rules` or the {guilabel}`Import settings` tab.
44+
You will see the {guilabel}`Import caching profiles` control panel.
45+
46+
````{card}
47+
```{image} /_static/caching/import-caching-profiles.png
48+
:alt: Import caching profiles control panel
49+
:target: /_static/caching/import-caching-profiles.png
50+
```
51+
+++
52+
_Import caching profiles control panel_
53+
````
54+
55+
Select options that are appropriate for your caching environment.
56+
57+
{guilabel}`With caching proxy`
58+
: Settings useful for setups with a caching proxy such as Squid or Varnish
59+
60+
{guilabel}`Without caching proxy`
61+
: Settings useful for setups without a caching proxy such as Squid or Varnish
62+
63+
{guilabel}`Take a snapshot of the site prior to importing new setting.`
64+
: This allows rollback to a previous state via the `portal_setup` tool.
65+
66+
2267
(enable-caching-label)=
2368

2469
## Enable caching

docs/deployment/caching/rulesets-and-caching-operations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ myst:
1111

1212
# Rulesets and caching operations
1313

14+
This chapter requires that you first {ref}`import-a-caching-profile-label` and {ref}`enable-caching-label`.
15+
1416
The caching infrastructure works on the principle of *rulesets* mapped to *caching operations*.
1517

1618
A ruleset is basically just a name, and is normally applied in {term}`ZCML` by the author of a particular view.

0 commit comments

Comments
 (0)