Skip to content

Commit 4cc0dd7

Browse files
committed
Clean up of caching/profiles.md
- Use MyST syntax for GUI elements. - Fix grammar.
1 parent b5c2706 commit 4cc0dd7

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

docs/deployment/caching/profiles.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,36 @@ All persistent configuration for the caching machinery is stored in the configur
1515

1616
This can be modified using the `registry.xml` GenericSetup import step.
1717

18-
The *Import settings* tab of the control panel allows you to import these caching profiles.
18+
The {guilabel}`Import settings` tab of the control panel allows you to import these caching profiles.
1919

2020

2121
## Default caching profiles
2222

2323
`plone.app.caching` includes two default caching profiles.
24-
These profiles encapsulate the cache settings that are known to work well with a typical default Plone installation:
24+
These profiles encapsulate the cache settings that are known to work well with a typical default Plone installation:
2525

26-
### Without caching proxy
26+
### {guilabel}`Without caching proxy`
2727

2828
Settings useful for setups without a caching proxy.
2929

30-
### With caching proxy
30+
### {guilabel}`With caching proxy`
3131

32-
Settings useful for setups with a caching proxy such Varnish or a CDN.
33-
The only difference from the "without caching proxy" profile are some settings to enable proxy caching of files/images in content space and content feeds.
32+
Settings useful for setups with a caching proxy, such as Varnish or a CDN.
33+
The only difference from the {guilabel}`Without caching proxy` profile are some settings to enable proxy caching of files and images in content space and content feeds.
3434

3535
## Custom caching profiles
3636

3737
Caching policies are often a compromise between speed and freshness.
3838
More aggressive caching often comes at the cost of increased risk of stale responses.
39-
The default profiles provided tend to err on the side of freshness over speed so there is some room for tweaking if greater speed is desired.
39+
The provided default profiles tend to err on the side of freshness over speed, leaving room for greater speed if desired.
4040

4141
Customization may also be needed if third-party products are installed which require special treatment.
4242
Examine the HTTP response headers to determine whether the third-party product requires special treatment.
4343
Most simple cases probably can be solved by adding the content type or template to the appropriate mapping.
44-
More complicated cases, may require custom caching operations.
44+
More complicated cases may require custom caching operations.
4545

4646
A GenericSetup profile used for caching should be registered for the `ICacheProfiles` marker interface to distinguish it from more general profiles used to install a product.
47-
This also hides the profile from Plone's Add-ons control panel.
47+
This also hides the profile from Plone's {guilabel}`Add-ons` control panel.
4848

4949
Here is an example from this package:
5050

@@ -59,9 +59,7 @@ Here is an example from this package:
5959
/>
6060
```
6161

62-
The directory `profiles/with-caching-proxy` contains a single import step, `registry.xml`,
63-
containing settings to configure the ruleset to operation mapping,
64-
and setting options for various operations.
62+
The directory `profiles/with-caching-proxy` contains a single import step, `registry.xml`, containing settings to configure the ruleset to operation mapping, and setting options for various operations.
6563

6664
At the time of writing, this includes:
6765

@@ -93,7 +91,7 @@ For example:
9391
```
9492

9593
This enables RAM caching for the "weak caching" operation for resources using the ruleset `plone.content.itemView`.
96-
The default is defined in the main `registry.xml` as::
94+
The default is defined in the main `registry.xml` as shown below.
9795

9896
```xml
9997
<record name="plone.app.caching.weakCaching.ramCache">
@@ -106,10 +104,10 @@ The default is defined in the main `registry.xml` as::
106104
</record>
107105
```
108106

109-
Notice how we use a *field reference* to avoid having to re-define the field.
107+
Notice how we use a _field reference_ to avoid having to re-define the field.
110108

111-
It may be useful looking at these bundled `registry.xml` for inspiration if you are building your own caching profile.
112-
Alternatively, you can export the registry from the `portal_setup` tool and pull out the records under the prefixes `plone.caching` and `plone.app.caching`.
109+
It may be useful to look at the bundled `registry.xml` for inspiration if you are building your own caching profile.
110+
Alternatively, you can export the registry from the `portal_setup` tool, and pull out the records under the prefixes `plone.caching` and `plone.app.caching`.
113111

114112
Typically, `registry.xml` is all that is required, but you are free to add additional import steps if required.
115113
You can also add a `metadata.xml` and use the GenericSetup dependency mechanism to install other profiles on the fly.

0 commit comments

Comments
 (0)