Skip to content

Commit ec2f8fc

Browse files
pedrosousapedrosousa
authored
[Rules] Update partials (#19959)
1 parent f4601e9 commit ec2f8fc

File tree

36 files changed

+122
-155
lines changed

36 files changed

+122
-155
lines changed

‎src/content/docs/rules/cloud-connector/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Cloud Connector (beta) allows you to route matching incoming traffic from your w
1717

1818
<Render
1919
file="rules-requirements"
20-
params={{ one: "Cloud Connector requires" }}
20+
params={{ sentenceIntro: "Cloud Connector requires" }}
2121
/>
2222

2323
## How it works

‎src/content/docs/rules/compression-rules/create-api.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ When creating a compression rule via API, make sure you:
2424

2525
<Render
2626
file="rules-creation-workflow"
27-
params={{ one: "a compression rule", two: "http_response_compression" }}
27+
params={{
28+
ruleName: "a compression rule",
29+
phaseName: "http_response_compression",
30+
}}
2831
/>
2932

3033
## Examples

‎src/content/docs/rules/compression-rules/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When there is a match for a compression rule configured with several compression
1515

1616
<Render
1717
file="rules-requirements"
18-
params={{ one: "Compression Rules require" }}
18+
params={{ sentenceIntro: "Compression Rules require" }}
1919
/>
2020

2121
## Get started

‎src/content/docs/rules/configuration-rules/create-api.mdx‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,34 @@ sidebar:
77
head:
88
- tag: title
99
content: Create a configuration rule via API
10-
1110
---
1211

13-
import { Details, Render } from "~/components"
12+
import { Details, Render } from "~/components";
1413

1514
Use the [Rulesets API](/ruleset-engine/rulesets-api/) to create configuration rules via API.
1615

1716
## Basic rule settings
1817

1918
When creating a configuration rule via API, make sure you:
2019

21-
* Set the rule action to `set_config`.
22-
* Define the parameters in the `action_parameters` field according to the [settings](/rules/configuration-rules/settings/) you wish to override for matching requests.
23-
* Deploy the rule to the `http_config_settings` phase at the zone level.
20+
- Set the rule action to `set_config`.
21+
- Define the parameters in the `action_parameters` field according to the [settings](/rules/configuration-rules/settings/) you wish to override for matching requests.
22+
- Deploy the rule to the `http_config_settings` phase at the zone level.
2423

2524
## Procedure
2625

27-
<Render file="rules-creation-workflow" params={{ one: "a configuration rule", two: "http_config_settings" }} />
26+
<Render
27+
file="rules-creation-workflow"
28+
params={{
29+
ruleName: "a configuration rule",
30+
phaseName: "http_config_settings",
31+
}}
32+
/>
2833

2934
Make sure your API token has the [required permissions](#required-api-token-permissions) to perform the API operations.
3035

3136
## Example requests
3237

33-
3438
<Details header="Example: Add a rule that enables Email Obfuscation and Browser Integrity Check">
3539

3640
The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — enabling Email Obfuscation and Browser Integrity Check for the contacts page — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation:
@@ -55,10 +59,8 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
5559
}'
5660
```
5761

58-
5962
</Details>
6063

61-
6264
<Details header="Example: Add a rule that turns on I'm Under Attack mode for the admin area">
6365

6466
The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — turning on I'm Under Attack mode for the administration area — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation:
@@ -82,13 +84,12 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
8284
}'
8385
```
8486

85-
8687
</Details>
8788

88-
***
89+
---
8990

9091
## Required API token permissions
9192

9293
The API token used in API requests to manage configuration rules must have at least the following permission:
9394

94-
* *Zone* > *Config Rules* > *Edit*
95+
- _Zone_ > _Config Rules_ > _Edit_

‎src/content/docs/rules/configuration-rules/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The configuration rule expression will determine to which requests the rule sett
1616

1717
<Render
1818
file="rules-requirements"
19-
params={{ one: "Configuration Rules require" }}
19+
params={{ sentenceIntro: "Configuration Rules require" }}
2020
/>
2121

2222
---

‎src/content/docs/rules/configuration-rules/settings.mdx‎

Lines changed: 16 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ sidebar:
66
head:
77
- tag: title
88
content: Configuration Rules settings
9-
109
---
1110

12-
import { Details, Render } from "~/components"
11+
import { Details, Render } from "~/components";
1312

1413
You can change the configuration settings described below in a configuration rule.
1514

@@ -19,7 +18,6 @@ You can change the configuration settings described below in a configuration rul
1918

2019
Use this setting to turn on or off Automatic HTTPS Rewrites for matching requests.
2120

22-
2321
<Details header="API information">
2422

2523
API configuration property name: `"automatic_https_rewrites"` (boolean).
@@ -32,7 +30,6 @@ API configuration property name: `"automatic_https_rewrites"` (boolean).
3230

3331
<Render file="configuration-rule-link-to-examples" />
3432

35-
3633
</Details>
3734

3835
## Browser Integrity Check
@@ -41,7 +38,6 @@ API configuration property name: `"automatic_https_rewrites"` (boolean).
4138

4239
Use this setting to turn on or off Browser Integrity Check for matching requests.
4340

44-
4541
<Details header="API information">
4642

4743
API configuration property name: `"bic"` (boolean).
@@ -54,7 +50,6 @@ API configuration property name: `"bic"` (boolean).
5450

5551
<Render file="configuration-rule-link-to-examples" />
5652

57-
5853
</Details>
5954

6055
## Disable Apps
@@ -63,7 +58,6 @@ API configuration property name: `"bic"` (boolean).
6358

6459
Use this setting to turn off all active Cloudflare Apps for matching requests.
6560

66-
6761
<Details header="API information">
6862

6963
API configuration property name: `"disable_apps"` (boolean).
@@ -76,7 +70,6 @@ API configuration property name: `"disable_apps"` (boolean).
7670

7771
<Render file="configuration-rule-link-to-examples" />
7872

79-
8073
</Details>
8174

8275
## Disable Real User Monitoring (RUM)
@@ -85,8 +78,7 @@ API configuration property name: `"disable_apps"` (boolean).
8578

8679
Use this setting to turn off Web Analytics for matching requests.
8780

88-
<Render file="configuration-rule-wins-over-rum-rule" params={{ one: "Configuration rules", two: "Web Analytics rules" }} />
89-
81+
<Render file="configuration-rule-wins-over-rum-rule" />
9082

9183
<Details header="API information">
9284

@@ -100,7 +92,6 @@ API configuration property name: `"disable_rum"` (boolean).
10092

10193
<Render file="configuration-rule-link-to-examples" />
10294

103-
10495
</Details>
10596

10697
## Disable Zaraz
@@ -109,7 +100,6 @@ API configuration property name: `"disable_rum"` (boolean).
109100

110101
Use this setting to turn off Zaraz for matching requests.
111102

112-
113103
<Details header="API information">
114104

115105
API configuration property name: `"disable_zaraz"` (boolean).
@@ -122,7 +112,6 @@ API configuration property name: `"disable_zaraz"` (boolean).
122112

123113
<Render file="configuration-rule-link-to-examples" />
124114

125-
126115
</Details>
127116

128117
## Hotlink Protection
@@ -131,7 +120,6 @@ API configuration property name: `"disable_zaraz"` (boolean).
131120

132121
Use this setting to turn on or off Hotlink Protection for matching requests.
133122

134-
135123
<Details header="API information">
136124

137125
API configuration property name: `"hotlink_protection"` (boolean).
@@ -144,7 +132,6 @@ API configuration property name: `"hotlink_protection"` (boolean).
144132

145133
<Render file="configuration-rule-link-to-examples" />
146134

147-
148135
</Details>
149136

150137
## Email Obfuscation
@@ -153,7 +140,6 @@ API configuration property name: `"hotlink_protection"` (boolean).
153140

154141
Use this setting to turn on or off Email Obfuscation for matching requests.
155142

156-
157143
<Details header="API information">
158144

159145
API configuration property name: `"email_obfuscation"` (boolean).
@@ -166,7 +152,6 @@ API configuration property name: `"email_obfuscation"` (boolean).
166152

167153
<Render file="configuration-rule-link-to-examples" />
168154

169-
170155
</Details>
171156

172157
## Fonts
@@ -175,7 +160,6 @@ API configuration property name: `"email_obfuscation"` (boolean).
175160

176161
Use this setting to turn on or off Cloudflare Fonts for matching requests.
177162

178-
179163
<Details header="API information">
180164

181165
API configuration property name: `"fonts"` (boolean).
@@ -188,7 +172,6 @@ API configuration property name: `"fonts"` (boolean).
188172

189173
<Render file="configuration-rule-link-to-examples" />
190174

191-
192175
</Details>
193176

194177
## Mirage
@@ -197,7 +180,6 @@ API configuration property name: `"fonts"` (boolean).
197180

198181
Use this setting to turn on or off Mirage for matching requests.
199182

200-
201183
<Details header="API information">
202184

203185
API configuration property name: `"mirage"` (boolean).
@@ -210,7 +192,6 @@ API configuration property name: `"mirage"` (boolean).
210192

211193
<Render file="configuration-rule-link-to-examples" />
212194

213-
214195
</Details>
215196

216197
## Opportunistic Encryption
@@ -219,7 +200,6 @@ API configuration property name: `"mirage"` (boolean).
219200

220201
Use this setting to turn on or off Opportunistic Encryption for matching requests.
221202

222-
223203
<Details header="API information">
224204

225205
API configuration property name: `"opportunistic_encryption"` (boolean).
@@ -232,7 +212,6 @@ API configuration property name: `"opportunistic_encryption"` (boolean).
232212

233213
<Render file="configuration-rule-link-to-examples" />
234214

235-
236215
</Details>
237216

238217
## Polish
@@ -241,13 +220,12 @@ API configuration property name: `"opportunistic_encryption"` (boolean).
241220

242221
Use this setting to configure Polish for matching requests:
243222

244-
* Off
245-
* Lossless
246-
* Lossy
223+
- Off
224+
- Lossless
225+
- Lossy
247226

248227
Refer to [Compression options](/images/polish/compression/#compression-options) for more information on these values.
249228

250-
251229
<Details header="API information">
252230

253231
API configuration property name: `"polish"` (string).
@@ -262,7 +240,6 @@ API values: `"off"`, `"lossless"`, `"lossy"`.
262240

263241
<Render file="configuration-rule-link-to-examples" />
264242

265-
266243
</Details>
267244

268245
## Rocket Loader
@@ -271,7 +248,6 @@ API values: `"off"`, `"lossless"`, `"lossy"`.
271248

272249
Use this setting to turn on or off Rocket Loader for matching requests.
273250

274-
275251
<Details header="API information">
276252

277253
API configuration property name: `"rocket_loader"` (boolean).
@@ -284,7 +260,6 @@ API configuration property name: `"rocket_loader"` (boolean).
284260

285261
<Render file="configuration-rule-link-to-examples" />
286262

287-
288263
</Details>
289264

290265
## Security Level
@@ -293,16 +268,15 @@ API configuration property name: `"rocket_loader"` (boolean).
293268

294269
Use this setting to select the security level for matching requests:
295270

296-
* Off
297-
* Essentially Off
298-
* Low
299-
* Medium
300-
* High
301-
* I'm Under Attack
271+
- Off
272+
- Essentially Off
273+
- Low
274+
- Medium
275+
- High
276+
- I'm Under Attack
302277

303278
Refer to [Security levels](/waf/tools/security-level/#security-levels) for more information on these values.
304279

305-
306280
<Details header="API information">
307281

308282
API configuration property name: `"security_level"` (string).
@@ -317,7 +291,6 @@ API values: `"off"`, `"essentially_off"`, `"low"`, `"medium"`, `"high"`, `"under
317291

318292
<Render file="configuration-rule-link-to-examples" />
319293

320-
321294
</Details>
322295

323296
## SSL
@@ -326,15 +299,14 @@ API values: `"off"`, `"essentially_off"`, `"low"`, `"medium"`, `"high"`, `"under
326299

327300
Use this setting to configure the SSL/TLS encryption mode for matching requests:
328301

329-
* Off
330-
* Flexible
331-
* Full
332-
* Strict
333-
* Origin Pull
302+
- Off
303+
- Flexible
304+
- Full
305+
- Strict
306+
- Origin Pull
334307

335308
Refer to [Available encryption modes](/ssl/origin-configuration/ssl-modes/#available-encryption-modes) for more information on these values.
336309

337-
338310
<Details header="API information">
339311

340312
API configuration property name: `"ssl"` (string).
@@ -349,7 +321,6 @@ API values: `"off"`, `"flexible"`, `"full"`, `"strict"`, `"origin_pull"`.
349321

350322
<Render file="configuration-rule-link-to-examples" />
351323

352-
353324
</Details>
354325

355326
## SXG
@@ -358,7 +329,6 @@ API values: `"off"`, `"flexible"`, `"full"`, `"strict"`, `"origin_pull"`.
358329

359330
Use this setting to turn on or off signed exchanges for matching requests.
360331

361-
362332
<Details header="API information">
363333

364334
API configuration property name: `"sxg"` (boolean).
@@ -371,5 +341,4 @@ API configuration property name: `"sxg"` (boolean).
371341

372342
<Render file="configuration-rule-link-to-examples" />
373343

374-
375344
</Details>

0 commit comments

Comments
 (0)