Skip to content

[Challenges] Update sidebar navigation + more information on individual pages #21862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: production
Choose a base branch
from

Conversation

patriciasantaana
Copy link
Contributor

Summary

Reorganizes the current state of Cloudflare Challenges documentation + adds more information to existing pages

Documentation checklist

  • The documentation style guide has been adhered to.
  • 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.

Copy link
Contributor

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

Reorganized Cloudflare Challenges documentation and enhanced individual pages with additional information.

  • Reorganized sidebar navigation for better accessibility of challenge types and related content.
  • Added new pages detailing challenge types and JavaScript detections.
  • Updated existing pages with more comprehensive information on challenges and their configurations.

Modified Files

  • src/content/docs/fundamentals/security/cloudflare-challenges/index.mdx
  • src/content/docs/waf/troubleshooting/faq.mdx

Added Files

  • src/content/docs/fundamentals/security/cloudflare-challenges/challenge-types/challenge-pages.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/challenge-types/index.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/challenge-types/javascript-detections.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/reference/index.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/reference/supported-browsers.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/reference/supported-languages.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/troubleshooting/frequently-asked-questions.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/troubleshooting/index.mdx

Renamed Files

  • src/content/docs/fundamentals/security/cloudflare-challenges/reference/challenge-solve-rate.mdx
  • src/content/docs/fundamentals/security/cloudflare-challenges/troubleshooting/challenge-solve-issues.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.

Copy link
Contributor

github-actions bot commented Apr 21, 2025

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /fundamentals/security/cloudflare-challenges/challenge-passage/
  • /fundamentals/security/cloudflare-challenges/challenge-solve-rate/
  • /fundamentals/security/cloudflare-challenges/challenge-solve-issues/

Copy link
Contributor

github-actions bot commented Apr 21, 2025

Preview URL: https://b4f86e52.preview.developers.cloudflare.com
Preview Branch URL: https://patricia-pcx17012-challenges.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/challenge-pages/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/challenge-pages/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/frequently-asked-questions/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/frequently-asked-questions/
https://developers.cloudflare.com/waf/troubleshooting/faq/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/waf/troubleshooting/faq/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/supported-browsers/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/supported-browsers/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/supported-languages/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/supported-languages/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-passage/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-passage/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/
https://developers.cloudflare.com/security/settings/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/security/settings/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/javascript-detections/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-types/javascript-detections/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/challenge-solve-rate/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/reference/challenge-solve-rate/
https://developers.cloudflare.com/fundamentals/reference/under-attack-mode/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/reference/under-attack-mode/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/challenge-solve-issues/ https://patricia-pcx17012-challenges.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/troubleshooting/challenge-solve-issues/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

New content

Copy link
Contributor Author

Choose a reason for hiding this comment

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

New content

Copy link
Contributor Author

Choose a reason for hiding this comment

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

New content

@patriciasantaana patriciasantaana marked this pull request as ready for review May 6, 2025 14:58
:::

For the `cf-mitigated` header, `challenge` is the only valid value. The header is set for all challenge page types.
The script runs a short set of tasks and, if successful, sets a `cf_clearance` cookie indicating that the visitor passed the check. It is exposed as the `cf.bot_management.js_detection.passed` field that you can use in [WAF custom rules](/waf/custom-rules/) to take further action — such as issuing an interstitial challenge page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The script runs a short set of tasks and, if successful, sets a `cf_clearance` cookie indicating that the visitor passed the check. It is exposed as the `cf.bot_management.js_detection.passed` field that you can use in [WAF custom rules](/waf/custom-rules/) to take further action — such as issuing an interstitial challenge page.
The script runs a short set of tasks and, if successful, sets a `cf_clearance` cookie indicating that the visitor passed the check. This is exposed as the `cf.bot_management.js_detection.passed` field that you can use in [WAF custom rules](/waf/custom-rules/) to take further action — such as issuing an interstitial challenge page.

Comment on lines +14 to +19
- Google Chrome
- Firefox
- Safari
- Microsoft Edge
- Google Chrome on mobile
- Safari on mobile
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Google Chrome
- Firefox
- Safari
- Microsoft Edge
- Google Chrome on mobile
- Safari on mobile
- Google Chrome
- Google Chrome on mobile
- Safari
- Safari on mobile
- Microsoft Edge
- Firefox

Are Chrome on mobile and Safari on mobile specific names for the browsers? If not, we could use (desktop and mobile)?

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.

4 participants