Skip to content

Commit 2033681

Browse files
committed
Clean up of caching/index.md
- We cache content in Plone, not Plone itself. - Headings for overview or introduction are unnecessary, and leaving a heading without content looks weird. Instead just smoosh an introduction under the page title. - Shorten introduction of caching. - Add Glossary term of CDN. - Add link to plone.app.caching repo. - Grammar fixes.
1 parent 136f117 commit 2033681

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

docs/deployment/caching/index.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
---
22
myst:
33
html_meta:
4-
"description": "Caching Plone"
5-
"property=og:description": "Caching Plone"
6-
"property=og:title": "Caching Plone"
4+
"description": "Caching content in Plone"
5+
"property=og:description": "Caching content in Plone"
6+
"property=og:title": "Caching content in Plone"
77
"keywords": "Plone, deployment, automation, caching"
88
---
99

1010
(caching-label)=
1111

1212
# Caching
1313

14-
## Overview
14+
HTTP caching is a technique used to speed up the delivery of web content by storing previously requested resources, such as images, scripts, and stylesheets, in a cache.
1515

16-
HTTP caching is a technique used to speed up the delivery of web content by storing previously requested resources (such as images, scripts, and stylesheets) in a cache.
17-
When a user requests a resource, the cache can serve the resource directly from its storage, rather than having to fetch it from the original source.
16+
A web accelerator, such as {term}`Varnish`, may be used to implement HTTP caching.
17+
The usual set up will place the web accelerator between Plone and the Internet.
18+
When a request is made to the site, the web accelerator will intercept the request.
19+
It then checks to see if it has a cached copy of the requested resource.
20+
If a cached copy is found, the accelerator will serve the cached copy directly to the client, else it will make a request to the backend Plone server and then store a copy on the content in its local cache.
1821

19-
It is possible to use a web accelerator, like {term}`Varnish` to implement HTTP caching in your own premises.
20-
The usual setup will have the web accelerator installed between Plone and the Internet, and when a request is made to the site the web accelerator will intercept the request and check to see if it has a cached copy of the requested resource.
21-
If a cached copy is found, the accelerator will serve the cached copy directly to the client, otherwise it will make a request to the backend Plone server and then store a copy on the content in its local cache.
22-
23-
HTTP caching and the speed of delivering web content can be improved using a Content Delivery Network (CDN).
24-
A CDN is a network of servers located in various geographic regions that work together to deliver web content to users quickly and efficiently.
22+
HTTP caching and the speed of delivering web content can be improved using a {term}`Content Delivery Network` (CDN).
23+
A CDN is a network of servers located in various geographic regions that work together to deliver web content to users quickly and efficiently.
2524
When a user requests a resource from a website that uses a CDN, the request is directed to the closest server in the CDN, rather than having to travel all the way to the website's origin server.
2625

27-
## Plone support
26+
## Cache support in Plone
2827

29-
Plone ships with a powerful and extensible `HTTP` and `In-Memory` cache support, implemented by the package `plone.app.caching`.
28+
Plone ships with powerful and extensible `HTTP` and `In-Memory` cache support, implemented by the package [`plone.app.caching`](https://github.com/plone/plone.app.caching/).
3029

3130

3231
```{toctree}

docs/glossary.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -638,4 +638,8 @@ acquisition
638638
639639
Varnish
640640
[Varnish](https://varnish-cache.org) is a popular open source web accelerator that is used to implement HTTP caching.
641+
642+
Content Delivery Network
643+
CDN
644+
A Content Delivery Network (CDN) is a network of servers located in various geographic regions that work together to deliver web content to users quickly and efficiently.
641645
```

0 commit comments

Comments
 (0)