[Rules] Add ref field to Terraform and API examples

[pedrosousa]

Summary

Addresses PCX-16993.

[github-actions]

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

Pattern	Owners
/src/content/docs/cache/	@angelampcosta, @cloudflare/pcx-technical-writing
/src/content/docs/rules/	@pedrosousa, @cloudflare/pcx-technical-writing
/src/content/docs/terraform/	@dcpena, @cloudflare/pcx-technical-writing
*	@cloudflare/pcx-technical-writing

[hyperlint-ai]

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

Added ref fields to various examples in the documentation to enhance clarity and usability.

• Introduced ref fields in multiple compression rule examples for better identification.
• Updated API examples to include ref fields for configuration rules and custom errors.
• Enhanced Terraform examples with ref fields to improve documentation consistency.

Modified Files

• src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx
• src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx
• src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx
• src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx
• src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx
• src/content/docs/rules/configuration-rules/create-api.mdx
• src/content/docs/rules/configuration-rules/examples/define-single-configuration-terraform.mdx
• src/content/docs/rules/custom-errors/create-rules.mdx
• src/content/docs/rules/custom-errors/example-rules.mdx
• src/content/docs/rules/origin-rules/create-api.mdx
• src/content/docs/rules/origin-rules/examples/define-single-origin-terraform.mdx
• src/content/docs/rules/transform/request-header-modification/create-api.mdx
• src/content/docs/rules/transform/response-header-modification/create-api.mdx
• src/content/docs/rules/transform/url-rewrite/create-api.mdx
• src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx
• src/content/docs/rules/url-forwarding/single-redirects/create-api.mdx
• src/content/docs/rules/url-forwarding/single-redirects/terraform-example.mdx
• src/content/docs/terraform/additional-configurations/transform-rules.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.

[windsurf-bot]

💡 To request another review, post a new comment with "/windsurf-review".

[windsurf-bot]

The PR adds a ref field to the API example, but there's no explanation in the documentation about what this field is used for or why it's important. Consider adding a brief explanation about the purpose and benefits of using the ref field in rules.

[pedrosousa]

The explanation actually exists and is located in the Terraform docs. We're linking there using a partial.

[github-actions]

Preview URL: https://ff5cfbf4.preview.developers.cloudflare.com
Preview Branch URL: https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/rules/transform/response-header-modification/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/transform/response-header-modification/create-api/
https://developers.cloudflare.com/rules/custom-errors/example-rules/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/custom-errors/example-rules/
https://developers.cloudflare.com/rules/transform/request-header-modification/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/transform/request-header-modification/create-api/
https://developers.cloudflare.com/rules/url-forwarding/bulk-redirects/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/url-forwarding/bulk-redirects/create-api/
https://developers.cloudflare.com/cache/how-to/cache-rules/terraform-example/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/cache/how-to/cache-rules/terraform-example/
https://developers.cloudflare.com/rules/transform/url-rewrite/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/transform/url-rewrite/create-api/
https://developers.cloudflare.com/rules/url-forwarding/single-redirects/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/url-forwarding/single-redirects/create-api/
https://developers.cloudflare.com/terraform/additional-configurations/transform-rules/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/terraform/additional-configurations/transform-rules/
https://developers.cloudflare.com/rules/configuration-rules/create-api/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/configuration-rules/create-api/
https://developers.cloudflare.com/rules/compression-rules/examples/disable-all-brotli/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/compression-rules/examples/disable-all-brotli/
https://developers.cloudflare.com/rules/compression-rules/examples/disable-compression-avif/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/compression-rules/examples/disable-compression-avif/
https://developers.cloudflare.com/rules/compression-rules/examples/enable-zstandard/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/compression-rules/examples/enable-zstandard/
https://developers.cloudflare.com/rules/compression-rules/examples/gzip-for-csv/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/compression-rules/examples/gzip-for-csv/
https://developers.cloudflare.com/rules/compression-rules/examples/only-brotli-url-path/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/compression-rules/examples/only-brotli-url-path/
https://developers.cloudflare.com/rules/custom-errors/create-rules/	https://pedro-pcx-16993-rules-use-ref-field.preview.developers.cloudflare.com/rules/custom-errors/create-rules/