Skip to content

[Cache] ELI5: Simplify cache-rules docs and fix critical bugs#30665

Open
Oxyjun wants to merge 1 commit intoproductionfrom
jun/cache/how-to/cache-rules/eli5
Open

[Cache] ELI5: Simplify cache-rules docs and fix critical bugs#30665
Oxyjun wants to merge 1 commit intoproductionfrom
jun/cache/how-to/cache-rules/eli5

Conversation

@Oxyjun
Copy link
Copy Markdown
Contributor

@Oxyjun Oxyjun commented May 7, 2026

Summary

Apply ELI5 analysis to 6 files in docs/cache/how-to/cache-rules/ (terraform-example.mdx skipped — correct as-is).

Critical fixes

  • settings.mdx: 3 invalid JSON examples with missing commas — would fail if copied by users
  • create-api.mdx: Wrong API link — pointed to Update ruleset endpoint instead of Update rule endpoint
  • create-dashboard.mdx: Skipped step number (jumped from 6 to 8)

Other changes

  • index.mdx: Tighten run-on sentence, add Oxford comma
  • order.mdx: Fix inconsistent Cache Rules capitalization (6 occurrences), remove future tense
  • settings.mdx: Fix misplaced hyphen (cache control-header to cache-control header), fix first person (our to the, we recommend to Cloudflare recommends), fix wordy phrasing
  • page-rules-migration.mdx: Add explanation of what Cache Everything means for migrating users, fix redundant note label
  • create-dashboard.mdx: Replace cloudflare.com with example.com per style guide

Apply ELI5 analysis to 6 files (1 skipped as correct Terraform ref):
- index.mdx: Tighten run-on sentence, add Oxford comma
- order.mdx: Fix inconsistent Cache Rules capitalization, remove future tense
- settings.mdx: Fix 3 invalid JSON examples (missing commas), fix misplaced hyphen in cache-control, fix first person (our/we), fix wordy phrasing
- page-rules-migration.mdx: Add Cache Everything explanation, fix redundant note label
- create-dashboard.mdx: Fix skipped step number (7 was missing), replace cloudflare.com with example.com per style guide
- create-api.mdx: Fix wrong API link (pointed to Update ruleset instead of Update rule)
@Oxyjun Oxyjun requested review from a team and dcpena as code owners May 7, 2026 09:04
@github-actions github-actions Bot added the product:cache Issues or PRs related to Cache label May 7, 2026
@github-actions github-actions Bot added the size/s label May 7, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

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.

2 participants