Skip to content
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

Vale config #16398

Merged
merged 7 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/styles/cloudflare/LatinTerms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# Warning: cloudflare.LatinTerms
#
# Checks for use of Latin terms.
# Uses https://github.com/errata-ai/Google/blob/master/Google/Latin.yml for ideas.
kodster28 marked this conversation as resolved.
Show resolved Hide resolved
#
# For a list of all options, see https://vale.sh/docs/topics/styles/

extends: substitution
message: "Use '%s' instead of '%s', but consider rewriting the sentence."
link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/abbreviations/#ie-vs-eg
level: warning
nonword: true
ignorecase: true
swap:
'\b(?:e\.?g[\s.,;:])': for example
'\b(?:i\.?e[\s.,;:])': that is
'\bvia\b': "with', 'through', or 'by using"
4 changes: 2 additions & 2 deletions .github/styles/cloudflare/RelativeLinks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "**Error**: When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`)."
level: error
message: "**Warning**: When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`)."
level: warning
scope: raw
raw:
- '\[.+\]\(https?:\/\/developers\.cloudflare\.com\/.+\)'
47 changes: 0 additions & 47 deletions .github/styles/cloudflare/ShellCodeBlocks.yml

This file was deleted.

38 changes: 0 additions & 38 deletions .github/workflows/vale.yml

This file was deleted.

8 changes: 7 additions & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
StylesPath = .github/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

[formats]
yml = yaml
mdx = md

[*]
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs, and angle brackets.
TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (https[^\n]+\[)

[*.md]
BasedOnStyles = cloudflare
BlockIgnores = (?s) *({{< ?code-block [^>]* >}}.*?{{< ?/ ?code-block >}})

[*.yaml]
BasedOnStyles = cloudflare
21 changes: 12 additions & 9 deletions src/content/docs/rules/page-rules/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,28 @@ source: https://support.cloudflare.com/hc/en-us/articles/218411427-What-do-the-c
title: Page Rules
sidebar:
order: 10

---

import { FeatureTable } from "~/components"
import { FeatureTable } from "~/components";

Page rules trigger one or more actions whenever a certain URL pattern is matched. Page Rules are available in **Rules** > **Page Rules**.

Let's go to [this page](/workers/).
kodster28 marked this conversation as resolved.
Show resolved Hide resolved

## Availability

The default number of allowed page rules depends on the domain plan as shown below.

<FeatureTable id="rules.page_rules" />

***
---

## Before getting started

It is important to understand a few Page Rules behaviors.

Help me get to the store, i.e., the place with bagels.
kodster28 marked this conversation as resolved.
Show resolved Hide resolved

### Page Rules require proxied DNS records

Page Rules require a [proxied](/dns/manage-dns-records/reference/proxied-dns-records/) DNS record for your page rule to work. Page Rules will not apply to hostnames that do not exist in DNS or are not being directed to Cloudflare.
Expand All @@ -39,9 +42,9 @@ Cloudflare recommends only using reserved IP addresses or domain names to avoid

For more information on reserved IP addresses or top level domains, please refer to these RFCs:

* [RFC 5737](https://datatracker.ietf.org/doc/html/rfc5737)
* [RFC 3849](https://datatracker.ietf.org/doc/html/rfc3849)
* [RFC 2606](https://datatracker.ietf.org/doc/html/rfc2606)
- [RFC 5737](https://datatracker.ietf.org/doc/html/rfc5737)
- [RFC 3849](https://datatracker.ietf.org/doc/html/rfc3849)
- [RFC 2606](https://datatracker.ietf.org/doc/html/rfc2606)

### Priority order matters

Expand All @@ -67,6 +70,6 @@ The `<SCHEME>` and `<PORT>` segments are optional. If omitted, `<SCHEME>` matche

When a page rule is disabled, actions will not trigger, but the rule will:

* Still appear in the Cloudflare dashboard.
* Be editable.
* Count against the number of rules allowed for your domain.
- Still appear in the Cloudflare dashboard.
- Be editable.
- Count against the number of rules allowed for your domain.
Loading