Skip to content

Commit

Permalink
BOTS-7194: update documentation to include warning of sbfm ruleset de…
Browse files Browse the repository at this point in the history
…prication (#8521)

* BOTS-7194: update documentation to include warning of future changes to the sbfm ruleset phase

* Update content/bots/_partials/_bfm-ruleset-engine.md

Co-authored-by: Patricia Santa Ana <103445940+patriciasantaana@users.noreply.github.com>

* Update content/bots/_partials/_bfm-ruleset-engine.md

Co-authored-by: Patricia Santa Ana <103445940+patriciasantaana@users.noreply.github.com>

* Update content/ruleset-engine/about/phases.md

Co-authored-by: Patricia Santa Ana <103445940+patriciasantaana@users.noreply.github.com>

* Apply suggestions from documentation review

* Create separate partial with change notice

* Add missing slash to URL

* Move change notice from Phases to Phases list

---------

Co-authored-by: Curtis Lowder <clowder@cloudflare.com>
Co-authored-by: Patricia Santa Ana <103445940+patriciasantaana@users.noreply.github.com>
Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
  • Loading branch information
4 people authored and Maddy-Cloudflare committed Apr 28, 2023
1 parent cc1dbb4 commit 91d7f39
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 1 deletion.
12 changes: 12 additions & 0 deletions content/bots/_partials/_bfm-change-notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
_build:
publishResources: false
render: never
list: never
---

{{<Aside type="warning" header="Change notice for Super Bot Fight Mode rulesets">}}

Cloudflare is changing the way you configure Super Bot Fight Mode rules. No action is need at this time. However, Cloudflare will deprecate the ability to modify the `http_request_sbfm` phase via the public Cloudflare API.

{{</Aside>}}
2 changes: 2 additions & 0 deletions content/bots/get-started/biz-and-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ For more on analytics, see [Bot Analytics](/bots/bot-analytics/biz-and-ent/).
## Ruleset Engine

{{<render file="_bfm-ruleset-engine.md">}}

{{<render file="_bfm-change-notice.md">}}
2 changes: 2 additions & 0 deletions content/bots/get-started/pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ You can see bot-related actions by going to **Security** > **Events**. Any reque
## Ruleset Engine

{{<render file="_bfm-ruleset-engine.md">}}

{{<render file="_bfm-change-notice.md">}}
2 changes: 1 addition & 1 deletion content/ruleset-engine/about/phases.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following diagram outlines the request handling process where requests go th

Cloudflare products are specific to one or more phases, and they add support for different features. Check the documentation for each Cloudflare product for details on the applicable phases.

Refer to [Phases list](/ruleset-engine/reference/phases-list) for a list of phases and their corresponding Cloudflare products.
Refer to [Phases list](/ruleset-engine/reference/phases-list/) for a list of phases and their corresponding Cloudflare products.

## Phase entry point ruleset

Expand Down
2 changes: 2 additions & 0 deletions content/ruleset-engine/reference/phases-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ The phases execute in the order they appear in the table.

\* _This phase is for configuration purposes only — the corresponding rules will not be executed at this stage in the request handling process._

{{<render productFolder="bots" file="_bfm-change-notice.md">}}

### Response phases

The phases execute in the order they appear in the table.
Expand Down

0 comments on commit 91d7f39

Please sign in to comment.