[Cache] ELI5 on root-level files#30600
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
Preview URL: https://c39dc1e4.preview.developers.cloudflare.com Files with changes (up to 15)
|
codyanthony850
left a comment
codyanthony850
left a comment
There was a problem hiding this comment.
Style review — 3 issues found (2 medium, 1 low)
|
|
||
| These code alterations only occur on the cacheable objects found at Cloudflare's edge and do not affect the original source. The changes will also be removed if the specific feature is disabled and the cache is purged. | ||
| Some Cloudflare features modify your HTML or cached objects at the edge to enable optimizations or security protections. | ||
|
|
There was a problem hiding this comment.
[medium] "The changes are removed if the feature is disabled and the cache is purged." — passive voice in three places ("are removed", "is disabled", "is purged"). Style guide prefers active voice.
| These alterations only affect cached copies at Cloudflare's edge and do not change your original source files. Cloudflare removes the changes when you disable the feature and purge the cache. |
| import { GlossaryTooltip } from "~/components" | ||
|
|
||
| Cloudflare makes customer websites faster by storing a copy of the website's content on the servers of our globally distributed data centers. Content can be either static or dynamic: static content is “[cacheable](/cache/concepts/default-cache-behavior/#default-cached-file-extensions)” or eligible for caching, and dynamic content is “uncacheable” or ineligible for caching. The cached copies of content are stored physically closer to users, optimized to be fast, and do not require recomputing. | ||
| Cloudflare speeds up websites by storing copies of content on its globally distributed data centers. |
There was a problem hiding this comment.
[medium] "Cloudflare speeds up websites by storing copies of content on its globally distributed data centers." — third-person voice; second person is preferred for addressing the reader.
| Cloudflare speeds up websites by storing copies of content on its globally distributed data centers. | |
| Cloudflare speeds up your website by caching content across globally distributed data centers. |
| Cloudflare makes customer websites faster by storing a copy of the website's content on the servers of our globally distributed data centers. Content can be either static or dynamic: static content is “[cacheable](/cache/concepts/default-cache-behavior/#default-cached-file-extensions)” or eligible for caching, and dynamic content is “uncacheable” or ineligible for caching. The cached copies of content are stored physically closer to users, optimized to be fast, and do not require recomputing. | ||
| Cloudflare speeds up websites by storing copies of content on its globally distributed data centers. | ||
|
|
||
| Content can be static or dynamic. Static content — such as images, CSS, and JavaScript files — is [cacheable](/cache/concepts/default-cache-behavior/#default-cached-file-extensions), meaning Cloudflare can store and serve it from its edge. Dynamic content, such as HTML pages, is not cached by default. |
There was a problem hiding this comment.
[low] The static/dynamic contrast framing implies dynamic content cannot be cached at all, but the "Make more resources cacheable" section below links to Cache Rules, which lets users cache dynamic content. Consider making the "by default" qualifier more explicit.
| Content can be static or dynamic. Static content — such as images, CSS, and JavaScript files — is [cacheable](/cache/concepts/default-cache-behavior/#default-cached-file-extensions), meaning Cloudflare can store and serve it from its edge. Dynamic content, such as HTML pages, is not cached by default. | |
| Content can be static or dynamic. Static content — such as images, CSS, and JavaScript files — is [cacheable](/cache/concepts/default-cache-behavior/#default-cached-file-extensions) by default. Dynamic content, such as HTML pages, is not cached by default, but you can use [Cache Rules](/cache/how-to/cache-rules/) to cache it. |
codyanthony850
left a comment
codyanthony850
left a comment
There was a problem hiding this comment.
Looks good. Please apply the suggestion on line 20 (dynamic content clarification) before merging.
3 participants
Summary
ELI5 pass on the root-level MDX files in
/cache/. Three of the five files (changelog.mdx,glossary.mdx,plans.mdx) are auto-generated component pages with no prose — skipped.index.mdxhad clear prose — no changes needed. Onlyget-started.mdxhad clarity issues.Key changes to
get-started.mdx:"cacheable"/"uncacheable"pattern with plain language/dns/proxy-status/All changes verified through adversarial fact-check review.
Documentation checklist