Skip to content

docs(cache): Clarify custom cache key behavior with single-file purge#32107

Open
mbullock1986 wants to merge 1 commit into
cloudflare:productionfrom
mbullock1986:cache-rules-custom-key-purge-docs
Open

docs(cache): Clarify custom cache key behavior with single-file purge#32107
mbullock1986 wants to merge 1 commit into
cloudflare:productionfrom
mbullock1986:cache-rules-custom-key-purge-docs

Conversation

@mbullock1986

Copy link
Copy Markdown
Contributor

Cache Rules that set custom cache keys require API purge with headers/cookies rather than dashboard single-file purge. This clarification reduces customer escalations about why single-file purge does not invalidate cached resources.

Summary

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Cache Rules that set custom cache keys require API purge with headers/cookies
rather than dashboard single-file purge. This clarification reduces customer
escalations about why single-file purge does not invalidate cached resources.
@mbullock1986
mbullock1986 requested review from a team, ack-cf and zaidoon1 as code owners July 16, 2026 14:34
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review

💡 2 suggestions found in commit 599793d.

Fix in your agent
Fix the following review findings in PR #32107 (https://github.com/cloudflare/cloudflare-docs/pull/32107).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, fix all legitimate findings. For any you decide to skip,
post a comment on this PR with the finding ID and your reasoning.

---

## Style Guide Review

### Suggestions (2)

#### SG-12fd64d3f601 · Passive voice
- **File:** `src/content/docs/cache/how-to/cache-rules/index.mdx` line 35
- **Issue:** Line uses passive voice: "the resulting cache entry is indexed by that key".
- **Fix:** Rewrite in active voice, e.g. "that key indexes the cache entry rather than the request URL alone."

#### SG-c08c1dbeb9e7 · Passive voice
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx` line 32
- **Issue:** Added line uses passive voice: 'it is treated as an empty value in the cache key.'
- **Fix:** Rewrite in active voice, e.g., 'The cache treats any missing header or cookie as an empty value.'

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

Suggestions (2)
File Issue
cache/how-to/cache-rules/index.mdx line 35 Passive voice — Line uses passive voice: "the resulting cache entry is indexed by that key". Fix: Rewrite in active voice, e.g. "that key indexes the cache entry rather than the request URL alone."
cache/how-to/purge-cache/purge-by-single-file.mdx line 32 Passive voice — Added line uses passive voice: 'it is treated as an empty value in the cache key.' Fix: Rewrite in active voice, e.g., 'The cache treats any missing header or cookie as an empty value.'
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@github-actions github-actions Bot added product:cache Issues or PRs related to Cache size/s labels Jul 16, 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.

3 participants