Skip to content

Conversation

@pedrosousa
Copy link
Contributor

Summary

Partially addresses PCX-16221.

Improves links between API docs and Terraform/dashboard info.
Adds several other links.
Uses the term "exception" in Terraform docs instead of "skip rule" (for managed rulesets).

@pedrosousa pedrosousa requested review from a team and ranbel as code owners April 16, 2025 17:48
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 16, 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

Improved linking between API documentation and Terraform/dashboard information, and updated terminology in the Terraform docs.

  • Enhanced links to related resources in the ruleset engine documentation.
  • Updated terminology from 'skip rule' to 'exception' in Terraform documentation.
  • Added new links for deploying managed and custom rulesets.
  • Included additional resources for using Terraform and the Cloudflare dashboard.

Modified Files

  • src/content/docs/ruleset-engine/basic-operations/deploy-rulesets.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/deploy-custom-ruleset.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/index.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/create-exception.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/deploy-managed-ruleset.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-managed-ruleset.mdx
  • src/content/docs/terraform/additional-configurations/waf-managed-rulesets.mdx
  • src/content/docs/waf/custom-rules/skip/options.mdx
  • src/content/partials/waf/managed-rulesets/api-account-example.mdx
  • src/content/partials/waf/managed-rulesets/api-zone-example.mdx

Added Files

  • src/content/partials/ruleset-engine/custom-rulesets-dashboard.mdx
  • src/content/partials/ruleset-engine/custom-rulesets-terraform.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

Preview URL: https://da57e3cc.preview.developers.cloudflare.com
Preview Branch URL: https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/deploy-custom-ruleset/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/deploy-custom-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-managed-ruleset/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-managed-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/deploy-managed-ruleset/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/deploy-managed-ruleset/
https://developers.cloudflare.com/ruleset-engine/basic-operations/deploy-rulesets/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/basic-operations/deploy-rulesets/
https://developers.cloudflare.com/terraform/additional-configurations/waf-managed-rulesets/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/terraform/additional-configurations/waf-managed-rulesets/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/create-custom-ruleset/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/create-custom-ruleset/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/add-rules-ruleset/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/add-rules-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/create-exception/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/create-exception/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/
https://developers.cloudflare.com/waf/custom-rules/skip/options/ https://pedro-pcx-16221-ruleset-engine-improve-linking-api-and-terraform.preview.developers.cloudflare.com/waf/custom-rules/skip/options/

@pedrosousa
Copy link
Contributor Author

Alternative preview links:

Preview Branch URL: https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/deploy-custom-ruleset/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/custom-rulesets/deploy-custom-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-managed-ruleset/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/managed-rulesets/override-managed-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/deploy-managed-ruleset/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/managed-rulesets/deploy-managed-ruleset/
https://developers.cloudflare.com/ruleset-engine/basic-operations/deploy-rulesets/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/basic-operations/deploy-rulesets/
https://developers.cloudflare.com/terraform/additional-configurations/waf-managed-rulesets/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/terraform/additional-configurations/waf-managed-rulesets/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/create-custom-ruleset/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/custom-rulesets/create-custom-ruleset/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/add-rules-ruleset/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/custom-rulesets/add-rules-ruleset/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/create-exception/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/managed-rulesets/create-exception/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/ruleset-engine/custom-rulesets/
https://developers.cloudflare.com/waf/custom-rules/skip/options/ https://pedro-pcx-16221-ruleset-engi.docs-preview1-796d3420.pages.dev/waf/custom-rules/skip/options/

@pedrosousa pedrosousa merged commit 732e01d into production Apr 16, 2025
13 checks passed
@pedrosousa pedrosousa deleted the pedro/PCX-16221-ruleset-engine-improve-linking-api-and-terraform branch April 16, 2025 19:24
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.

3 participants