mirror of
https://github.com/cloudflare/cloudflare-docs.git
synced 2026-01-16 23:11:06 +00:00
Rework hyperlint checks to plain text (#22304)
* partial * Tweaks * update
This commit is contained in:
Kody Jackson
GitHub
parent
d8ea07b524
commit
007e0a26c4
15 changed files with 35 additions and 486 deletions
|
|
@ -1,19 +1,15 @@
|
|||
StylesPath = automations/styles
|
||||
MinAlertLevel = suggestion
|
||||
IgnoredScopes = code, tt, img
|
||||
SkippedScopes = script, style, pre, figure, code
|
||||
CommentDelimiters = {/*, */}
|
||||
|
||||
[formats]
|
||||
mdx = md
|
||||
|
||||
[*]
|
||||
# Ignore code surrounded by plus sign, URLs, parameters defaults, and angle brackets.
|
||||
TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (https[^\n]+\[), ([^\n]+@[^\n]+\.[^\n])
|
||||
|
||||
[src/content/docs/fundamentals/*]
|
||||
BasedOnStyles = Vale, cloudflare, cloudflare-automation
|
||||
[*/content/{docs,partials}/*.md]
|
||||
BasedOnStyles = Vale, cloudflare
|
||||
Vale.Spelling = NO
|
||||
|
||||
[src/content/partials/fundamentals/*]
|
||||
BasedOnStyles = Vale, cloudflare, cloudflare-automation
|
||||
Vale.Spelling = NO
|
||||
[src/content/{docs,partials}/{agents,autorag,email-routing,pipelines,pub-sub,queues,realtime,support,workflows}/*]
|
||||
BasedOnStyles = Vale
|
||||
Vale.Spelling = NO
|
||||
Vale.Terms = NO
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
name: gitlab_base.EOLWhitespace
|
||||
description: |
|
||||
Checks that there is no useless whitespace at the end of lines.
|
||||
extends: existence
|
||||
message: "Remove whitespace characters from the end of the line. Only remove the whitespace and nothing else."
|
||||
link: https://docs.gitlab.com/development/documentation/styleguide/
|
||||
vocab: false
|
||||
level: warning
|
||||
scope: raw
|
||||
raw:
|
||||
- ' +\n'
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
extends: existence
|
||||
message: "Do not use exclamation points in text. Only replace the exclamation point and no other text."
|
||||
link: "https://developers.google.com/style/exclamation-points"
|
||||
nonword: true
|
||||
level: error
|
||||
action:
|
||||
name: edit
|
||||
params:
|
||||
- trim_right
|
||||
- "!"
|
||||
tokens:
|
||||
- '\w+!(?:\s|$)'
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
name: gitlab_base.HeadingLink
|
||||
description: |
|
||||
Do not include links in a heading.
|
||||
Headings already have self-referencing anchor links.
|
||||
extends: existence
|
||||
message: "Do not use links in headings. Only update the links and nothing else."
|
||||
vocab: false
|
||||
level: error
|
||||
ignorecase: true
|
||||
nonword: true
|
||||
link: https://docs.gitlab.com/development/documentation/styleguide/#links
|
||||
scope: raw
|
||||
tokens:
|
||||
- ^#+ .*\[.+\]\(\S+\).*$
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
extends: existence
|
||||
message: "Don't use end punctuation in headings. Only update the punctuation and nothing else."
|
||||
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
|
||||
nonword: true
|
||||
level: warning
|
||||
scope: heading
|
||||
action:
|
||||
name: edit
|
||||
params:
|
||||
- trim_right
|
||||
- ".?!"
|
||||
tokens:
|
||||
- "[a-z][.?!]$"
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
# Warning: cloudflare.NonStandardQuotes
|
||||
#
|
||||
# Use only standard single and double quotes, not left or right quotes.
|
||||
#
|
||||
# For a list of all options, see https://vale.sh/docs/topics/styles/
|
||||
extends: existence
|
||||
message: "Use standard single quotes or double quotes only. Do not use left or right quotes. Only update the quotes and nothing else. Double quotes are fine, so long as they aren't directional."
|
||||
level: warning
|
||||
ignorecase: true
|
||||
link: https://developers.cloudflare.com/style-guide/grammar/punctuation-marks-and-symbols/quotation-marks/
|
||||
scope: raw
|
||||
raw:
|
||||
- "[‘’“”]"
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
name: gitlab_base.UnclearAntecedent
|
||||
description: |
|
||||
Checks for words that need a noun for clarity.
|
||||
extends: existence
|
||||
message: "Instead of '%s', try starting this sentence with a specific subject and verb. Only update this part of the sentence and nothing else."
|
||||
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#this-these-that-those
|
||||
vocab: false
|
||||
level: warning
|
||||
ignorecase: false
|
||||
tokens:
|
||||
- "That is"
|
||||
- "That was"
|
||||
- "There are"
|
||||
- "There were"
|
||||
- "These are"
|
||||
- "These were"
|
||||
- "This is"
|
||||
- "This was"
|
||||
- "Those are"
|
||||
- "Those were"
|
||||
|
|
@ -1,382 +0,0 @@
|
|||
acls
|
||||
airtable
|
||||
agentless
|
||||
akamai
|
||||
akamai's
|
||||
allowlist
|
||||
allowlists
|
||||
allowlisted
|
||||
altus
|
||||
anonymizer
|
||||
anycast
|
||||
apis
|
||||
approvers
|
||||
apresia
|
||||
asn
|
||||
asns
|
||||
astro
|
||||
async
|
||||
atlassian
|
||||
automations
|
||||
backhaul
|
||||
bing
|
||||
bitly
|
||||
blazor
|
||||
blockchain
|
||||
bolded
|
||||
bool
|
||||
boolean
|
||||
booleans
|
||||
breakpoint
|
||||
broadcasted
|
||||
brotli
|
||||
bundler
|
||||
cacheable
|
||||
cacheability
|
||||
captcha
|
||||
captchas
|
||||
cas
|
||||
cdn
|
||||
cdns
|
||||
clientless
|
||||
clis
|
||||
cloudflared
|
||||
cloudforce
|
||||
cidrs
|
||||
colocation
|
||||
config
|
||||
contentful
|
||||
cPanel
|
||||
cpus
|
||||
cron
|
||||
crowdstrike
|
||||
crypto
|
||||
cryptocurrency
|
||||
Cryptomining
|
||||
ctx
|
||||
cyber
|
||||
cybersafe
|
||||
databrink
|
||||
datadog
|
||||
datastore
|
||||
ddos
|
||||
deno
|
||||
dependabot
|
||||
descaler
|
||||
deserialization
|
||||
deserializing
|
||||
dev
|
||||
devtools
|
||||
Digicert
|
||||
discoverability
|
||||
dispositioned
|
||||
dns
|
||||
doctype
|
||||
docusaurus
|
||||
drand
|
||||
egressed
|
||||
egressing
|
||||
eleventy
|
||||
enricher
|
||||
env
|
||||
equinix
|
||||
esbuild
|
||||
etag
|
||||
etags
|
||||
ethereum
|
||||
exfiltrate
|
||||
exfiltration
|
||||
failover
|
||||
fastly
|
||||
favicon
|
||||
focusable
|
||||
formspree
|
||||
frontmatter
|
||||
Gemalto
|
||||
gemfile
|
||||
geo
|
||||
geolocate
|
||||
Glendive
|
||||
gokeyless
|
||||
gpus
|
||||
grafana
|
||||
gridsome
|
||||
GSuite
|
||||
gzip
|
||||
gzipped
|
||||
hcaptcha
|
||||
healthchecks
|
||||
Heartbleed
|
||||
hellix
|
||||
hexo
|
||||
hibernatable
|
||||
hono
|
||||
hostname
|
||||
hostnames
|
||||
hsms
|
||||
HTMLRewriter
|
||||
http
|
||||
https
|
||||
hubspot
|
||||
hyperdrive
|
||||
hyperdrives
|
||||
hypertable
|
||||
hypertables
|
||||
iCloud
|
||||
ingressed
|
||||
interxion
|
||||
iterable
|
||||
iterables
|
||||
ivanti
|
||||
iprange
|
||||
ips
|
||||
ipsec
|
||||
jamf
|
||||
JAMStack
|
||||
Jetpack
|
||||
jira
|
||||
JMeter
|
||||
journaling
|
||||
journaled
|
||||
JSONata
|
||||
jq
|
||||
junos
|
||||
jwts
|
||||
kentik
|
||||
keyless
|
||||
Kibana
|
||||
Kokoris
|
||||
koropi
|
||||
kv
|
||||
kwai
|
||||
Kyber
|
||||
lambda
|
||||
langchain
|
||||
licensor
|
||||
Linux
|
||||
livestream
|
||||
llms
|
||||
lockdown
|
||||
lowercased
|
||||
logpull
|
||||
logpush
|
||||
logshare
|
||||
lookback
|
||||
lookups
|
||||
loopback
|
||||
lossy
|
||||
malvertizing
|
||||
marseille
|
||||
maxmind
|
||||
mbps
|
||||
megaport
|
||||
Memcache
|
||||
meraki
|
||||
middleware
|
||||
mimecast
|
||||
miniflare
|
||||
misconfigured
|
||||
mitigations
|
||||
mixpanel
|
||||
momento
|
||||
monorepo
|
||||
monorepos
|
||||
monospace
|
||||
multifactor
|
||||
nameserver
|
||||
nameservers
|
||||
namespace
|
||||
namespaced
|
||||
namespaces
|
||||
nats
|
||||
Netflow
|
||||
netlify
|
||||
netmask
|
||||
nonces
|
||||
npm
|
||||
nShield
|
||||
nuxt
|
||||
oauth
|
||||
offboarding
|
||||
offramp
|
||||
okta
|
||||
onramp
|
||||
onboarded
|
||||
onboarding
|
||||
openssl
|
||||
pagerduty
|
||||
pageview
|
||||
pageviews
|
||||
passthrough
|
||||
pathing
|
||||
pdfs
|
||||
performant
|
||||
pfSense
|
||||
pinecone
|
||||
plaintext
|
||||
pnpm
|
||||
polyfill
|
||||
polyfills
|
||||
postgres
|
||||
preact
|
||||
preconfigured
|
||||
preconnect
|
||||
prefetch
|
||||
prefetching
|
||||
preload
|
||||
prepend
|
||||
prepended
|
||||
prepending
|
||||
prepends
|
||||
prequeue
|
||||
prequeueing
|
||||
prisma
|
||||
proxied
|
||||
proxying
|
||||
Proxyflare
|
||||
punycode
|
||||
qradar
|
||||
qstash
|
||||
Qualys
|
||||
quantiles
|
||||
quic
|
||||
quickstarts
|
||||
quora
|
||||
qwik
|
||||
railgun
|
||||
readme
|
||||
realtime
|
||||
recaptcha
|
||||
recommender
|
||||
redactions
|
||||
Redsys
|
||||
referer
|
||||
repo
|
||||
revalidated
|
||||
revalidates
|
||||
revalidating
|
||||
rollout
|
||||
rollup
|
||||
routable
|
||||
rubygems
|
||||
ruleset
|
||||
rulesets
|
||||
runtimes
|
||||
sdk
|
||||
sdks
|
||||
Sectigo
|
||||
serializable
|
||||
severity
|
||||
serverless
|
||||
siems
|
||||
sFlow
|
||||
sharding
|
||||
shortcode
|
||||
shortcodes
|
||||
signatureless
|
||||
sippy
|
||||
slackbot
|
||||
snapchat
|
||||
softflowd
|
||||
sourcemap
|
||||
sparkline
|
||||
splunk
|
||||
SQLi
|
||||
ssl
|
||||
stackable
|
||||
Storyblok
|
||||
strapi
|
||||
stringify
|
||||
strongswan
|
||||
stytch
|
||||
subcommand
|
||||
subcommands
|
||||
subfolder
|
||||
subfolders
|
||||
subhost
|
||||
subhosts
|
||||
submenu
|
||||
subnet
|
||||
subnets
|
||||
subpage
|
||||
subpages
|
||||
subpath
|
||||
subpaths
|
||||
subreddit
|
||||
subrequest
|
||||
subrequests
|
||||
subshell
|
||||
substring
|
||||
sumologic
|
||||
supabase
|
||||
svgs
|
||||
swgs
|
||||
tcp
|
||||
teraco
|
||||
tiering
|
||||
tls
|
||||
todo
|
||||
toolchain
|
||||
tooltip
|
||||
tooltips
|
||||
traceroute
|
||||
transpile
|
||||
transpiled
|
||||
transpiling
|
||||
ttls
|
||||
turso
|
||||
twilio
|
||||
Ubiquiti
|
||||
udp
|
||||
unapplied
|
||||
uncacheable
|
||||
uncached
|
||||
uncategorized
|
||||
unencrypted
|
||||
unindexed
|
||||
unmanaged
|
||||
unmetered
|
||||
unoptimized
|
||||
unproxied
|
||||
unredacted
|
||||
unsplash
|
||||
unscanned
|
||||
unscoped
|
||||
upstash
|
||||
unstyled
|
||||
untrusted
|
||||
uppercased
|
||||
uris
|
||||
urls
|
||||
util
|
||||
utms
|
||||
waf
|
||||
waitlist
|
||||
walkthrough
|
||||
wasm
|
||||
wayback
|
||||
webex
|
||||
webpack
|
||||
webpage
|
||||
webpages
|
||||
wireguard
|
||||
wireshark
|
||||
workerd
|
||||
www
|
||||
xata
|
||||
XPath
|
||||
vectorize
|
||||
velocloud
|
||||
vercel
|
||||
viewport
|
||||
vite
|
||||
vms
|
||||
vpn
|
||||
vpns
|
||||
vue
|
||||
yubikey
|
||||
yubikeys
|
||||
zaraz
|
||||
zaraz's
|
||||
zayo
|
||||
Zscaler
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
anycast
|
||||
Correct casings or misspellings for the following words. Ignore this rule if the words are in code blocks, `code fences`, or in HTML or Markdown links.
|
||||
|
||||
Bitbucket
|
||||
cdnjs
|
||||
CLI
|
||||
|
|
@ -30,15 +31,11 @@ unpkg
|
|||
UNIX
|
||||
URI
|
||||
URL
|
||||
Vectorize
|
||||
WebRTC
|
||||
WebSocket
|
||||
Wi-Fi
|
||||
WordPress
|
||||
Worker
|
||||
Workers
|
||||
[wW]rangler
|
||||
wrangler.toml
|
||||
Wrangler
|
||||
VMware
|
||||
VPN
|
||||
YubiKey
|
||||
|
|
@ -0,0 +1 @@
|
|||
Remove whitespace characters from the end of the line. Only remove the whitespace and nothing else.
|
||||
|
|
@ -0,0 +1 @@
|
|||
Do not use exclamation points (`!`) in text. Only replace the exclamation point and no other text.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
Do not include links in a heading. Headings already have self-referencing anchor links.
|
||||
|
||||
Only remove the link and nothing else.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
Do not use end punctuation in headings.
|
||||
|
||||
Only update the punctuation and nothing else.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
Do not use directional quotes (`‘`, `’`, `“`, `”`), either left or right.
|
||||
|
||||
Replace these marks with their non-directional equivalent (`'` or `"`). Only replace the directional quotes and nothing else.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
Instead of phrases like the following, try starting this sentence with a specific subject and verb. Only update this part of the sentence and nothing else.
|
||||
|
||||
Phrases to replace are:
|
||||
|
||||
- "That is"
|
||||
- "That was"
|
||||
- "There are"
|
||||
- "There were"
|
||||
- "These are"
|
||||
- "These were"
|
||||
- "This is"
|
||||
- "This was"
|
||||
- "Those are"
|
||||
- "Those were"
|
||||
Loading…
Add table
Reference in a new issue