Skip to content

[Cache] ELI5: Simplify troubleshooting docs#30638

Open
Oxyjun wants to merge 2 commits intoproductionfrom
jun/cache/troubleshooting/eli5
Open

[Cache] ELI5: Simplify troubleshooting docs#30638
Oxyjun wants to merge 2 commits intoproductionfrom
jun/cache/troubleshooting/eli5

Conversation

@Oxyjun
Copy link
Copy Markdown
Contributor

@Oxyjun Oxyjun commented May 6, 2026

Summary

  • Apply ELI5 (technical simplification) analysis to 4 pages in docs/cache/troubleshooting/
  • Add missing context, fix broken content, improve clarity of technical explanations

Changes by file

File Key changes
index.mdx Minor intro wording improvement
always-online.mdx Add intro explaining what Always Online does, fix broken list item (dangling "or"), clarify that Always Online only activates for 520-527 errors (not origin-returned 404/500/503), convert FAQ questions to headings, fix style guide issues ("we" to "Cloudflare", Cache-Control formatting)
dynamic-content-and-login-issues.mdx Fix Set-Cookie removal explanation to match source docs (removal happens because Edge TTL forces caching, not as a separate prior step), expand CSRF acronym on first use, move cross-reference link inline
mp4-videos-on-ios-and-safari.mdx Add "Why this happens" section explaining range requests and ETags with link to ETag reference, move rule ordering explanation before the steps (readers need to understand the approach before executing), describe visible symptom (black screen)

Review notes

All changes validated through adversarial review. No unsourced claims. Key fix: always-online.mdx had a broken list item and conflated origin-returned errors with origin-unreachable errors.

Apply ELI5 analysis to improve readability across 4 pages:
- index.mdx: Minor intro wording improvement
- always-online.mdx: Add intro context, fix broken list item, clarify 520-527 vs origin errors distinction, convert FAQ questions to headings, fix style (we -> Cloudflare, Cache-Control formatting)
- dynamic-content-and-login-issues.mdx: Fix Set-Cookie removal explanation to match source docs, expand CSRF acronym, move cross-reference inline
- mp4-videos-on-ios-and-safari.mdx: Add Why this happens section explaining range requests and ETags, move rule ordering explanation before steps
@Oxyjun Oxyjun requested review from a team and dcpena as code owners May 6, 2026 13:48
@github-actions github-actions Bot added size/s product:cache Issues or PRs related to Cache labels May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/cache/ @angelampcosta, @dcpena, @cloudflare/pcx-technical-writing, @cloudflare/product-owners

@Oxyjun Oxyjun self-assigned this May 6, 2026
Comment thread src/content/docs/cache/troubleshooting/always-online.mdx
Address PR review comment: FAQ section headings should be questions
since they appear under Frequently asked questions. Restored question
format while keeping the improved answer content.
## Best practices

- **Allow requests from the Internet Archive IP addresses.** The Internet Archive crawler sends requests directly to your origin server. Make sure you are not blocking the Internet Archive IP ranges: `207.241.224.0/20` and `208.70.24.0/21`.
- **The Internet Archive does not consider your origin server's `Cache-Control` header.** The Internet Archive archives pages regardless of `Cache-Control` directives because it archives content rather than caching it.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consider reframing this bullet in terms of what the user should do or not do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:cache Issues or PRs related to Cache size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants