Skip to content

Conversation

@db-cloudflare
Copy link
Contributor

Summary

Updating WAF documentation copy

Documentation checklist

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 17, 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 WAF documentation content to enhance clarity and consistency across various sections.

  • Standardized terminology by changing 'Security Analytics' to 'Security analytics' and 'Security dashboard (beta)' to 'Application security dashboard (beta)'.
  • Clarified descriptions related to domains and zones for consistency.
  • Improved the overall readability of the documentation by refining sentences and phrases.

Modified Files

  • src/content/docs/security/analytics.mdx
  • src/content/docs/security/index.mdx
  • src/content/docs/security/overview.mdx
  • src/content/docs/security/rules.mdx
  • src/content/docs/security/settings.mdx
  • src/content/docs/security/web-assets.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

## Security rules

The **Security rules** tab includes a list of different types of rules configured in your zone to protect your applications and resources.
The **Security rules** tab includes a list of different types of rules configured in your domain / zone to protect your applications and resources.
Copy link
Contributor

Choose a reason for hiding this comment

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

Agree with what Abby mentioned here. Let's choose one and keep it consistent.

Suggested change
The **Security rules** tab includes a list of different types of rules configured in your domain / zone to protect your applications and resources.
The **Security rules** tab includes a list of different types of rules configured in your domain to protect your applications and resources.

Copy link
Contributor Author

@db-cloudflare db-cloudflare Mar 17, 2025

Choose a reason for hiding this comment

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

Talked with patriciasantaana async, decided to use domain across all pages and use 'domain / zone' in this instance for rules.

@pedrosousa pedrosousa enabled auto-merge (squash) March 17, 2025 17:04
@pedrosousa pedrosousa merged commit adfdf10 into cloudflare:production Mar 17, 2025
6 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Mar 17, 2025
@holopin-bot
Copy link

holopin-bot bot commented Mar 17, 2025

Congratulations @db-cloudflare, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm8dbtbic00760cjjeuldswbz

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
---------

Co-authored-by: Patricia Santa Ana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:security size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants