Skip to content

Conversation

@pedrosousa
Copy link
Contributor

@pedrosousa pedrosousa commented May 8, 2025

Summary

Several small updates to the Snippets documentation.
Also updates the IP lists section anchor from #lists-with-ip-addresses-ip-lists to #ip-lists.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented May 8, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated Snippets documentation with several clarifications and corrections regarding IP lists.

  • Corrected references to IP lists across multiple documentation files.
  • Enhanced clarity in examples related to maintenance and suspicious request handling.
  • Updated the explanation of how Snippets work with request evaluation.

Modified Files

  • src/content/docs/ddos-protection/managed-rulesets/http/configure-api.mdx
  • src/content/docs/firewall/cf-dashboard/rule-preview.mdx
  • src/content/docs/firewall/cf-firewall-rules/index.mdx
  • src/content/docs/magic-firewall/about/list-types.mdx
  • src/content/docs/magic-firewall/best-practices/extended-ruleset.mdx
  • src/content/docs/magic-firewall/how-to/use-rules-list.mdx
  • src/content/docs/rules/snippets/examples/maintenance.mdx
  • src/content/docs/rules/snippets/examples/slow-suspicious-requests.mdx
  • src/content/docs/rules/snippets/how-it-works.mdx
  • src/content/docs/rules/transform/response-header-modification/index.mdx
  • src/content/docs/ruleset-engine/rules-language/values.mdx
  • src/content/docs/security/settings.mdx
  • src/content/docs/waf/custom-rules/use-cases/allow-traffic-from-ips-in-allowlist.mdx
  • src/content/docs/waf/rate-limiting-rules/best-practices.mdx
  • src/content/docs/waf/rate-limiting-rules/parameters.mdx
  • src/content/docs/waf/tools/ip-access-rules/index.mdx
  • src/content/docs/waf/tools/lists/custom-lists.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2025

Preview URL: https://010fe93f.preview.developers.cloudflare.com
Preview Branch URL: https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/rules/snippets/examples/maintenance/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/rules/snippets/examples/maintenance/
https://developers.cloudflare.com/rules/snippets/examples/slow-suspicious-requests/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/rules/snippets/examples/slow-suspicious-requests/
https://developers.cloudflare.com/ruleset-engine/rules-language/values/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/ruleset-engine/rules-language/values/
https://developers.cloudflare.com/ddos-protection/managed-rulesets/http/configure-api/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/ddos-protection/managed-rulesets/http/configure-api/
https://developers.cloudflare.com/magic-firewall/best-practices/extended-ruleset/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/magic-firewall/best-practices/extended-ruleset/
https://developers.cloudflare.com/waf/custom-rules/use-cases/allow-traffic-from-ips-in-allowlist/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/waf/custom-rules/use-cases/allow-traffic-from-ips-in-allowlist/
https://developers.cloudflare.com/waf/tools/lists/custom-lists/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/waf/tools/lists/custom-lists/
https://developers.cloudflare.com/rules/snippets/how-it-works/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/rules/snippets/how-it-works/
https://developers.cloudflare.com/firewall/cf-dashboard/rule-preview/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/firewall/cf-dashboard/rule-preview/
https://developers.cloudflare.com/firewall/cf-firewall-rules/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/firewall/cf-firewall-rules/
https://developers.cloudflare.com/magic-firewall/about/list-types/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/magic-firewall/about/list-types/
https://developers.cloudflare.com/magic-firewall/how-to/use-rules-list/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/magic-firewall/how-to/use-rules-list/
https://developers.cloudflare.com/rules/transform/response-header-modification/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/rules/transform/response-header-modification/
https://developers.cloudflare.com/security/settings/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/security/settings/
https://developers.cloudflare.com/waf/rate-limiting-rules/best-practices/ https://pedro-2025-05-07-rules-update-snippets.preview.developers.cloudflare.com/waf/rate-limiting-rules/best-practices/

## Custom list types

### Lists with IP addresses (IP lists)
### Lists with IP addresses (IP lists) {/* ip-lists */}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The comment sets the heading anchor name.

@nikitacano nikitacano merged commit fe5be3f into production May 9, 2025
13 checks passed
@nikitacano nikitacano deleted the pedro/2025-05-07-rules-update-snippets branch May 9, 2025 10:24
daisyfaithauma pushed a commit that referenced this pull request May 13, 2025
* Update IP lists anchor name

* Mention WAF attack score

* Update two snippet examples with rules also
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants