Menu
Open source
Last reviewed: September 19, 2024

Vale rules

Vale codifies our style guide into a series of rules that can be checked against your prose. The following is a list of all the rules that we’ve defined.

Errors

The following rules are considered errors and must be fixed.

Grafana.GoogleAMPM

Extends: existence

Use ‘AM’ or ‘PM’ (preceded by a space).

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \d{1,2}[AP]M
  • \d{1,2} ?[ap]m
  • \d{1,2} ?[aApP]\.[mM]\.

More information ->

Grafana.GoogleDateFormat

Extends: existence

Use ‘July 31, 2016’ format, not <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}
  • \d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}

More information ->

Grafana.GoogleEmDash

Extends: existence

Don’t put a space before or after a dash.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \s[—–]\s

More information ->

Grafana.GoogleEnDash

Extends: existence

Use an em dash (’—’) instead of ‘–’.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

More information ->

Grafana.GoogleGender

Extends: existence

Don’t use <CURRENT TEXT> as a gender-neutral pronoun.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • he/she
  • s/he
  • \(s\)he

More information ->

Grafana.GoogleGenderBias

Extends: substitution

Consider using <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
(?:alumnae|alumni)graduates
(?:alumna|alumnus)graduate
air(?:m[ae]n|wom[ae]n)pilot(s)
anchor(?:m[ae]n|wom[ae]n)anchor(s)
authoressauthor
camera(?:m[ae]n|wom[ae]n)camera operator(s)
chair(?:m[ae]n|wom[ae]n)chair(s)
congress(?:m[ae]n|wom[ae]n)member(s) of congress
door(?:m[ae]|wom[ae]n)concierge(s)
draft(?:m[ae]n|wom[ae]n)drafter(s)
fire(?:m[ae]n|wom[ae]n)firefighter(s)
fisher(?:m[ae]n|wom[ae]n)fisher(s)
fresh(?:m[ae]n|wom[ae]n)first-year student(s)
garbage(?:m[ae]n|wom[ae]n)waste collector(s)
lady lawyerlawyer
ladylikecourteous
landlordbuilding manager
mail(?:m[ae]n|wom[ae]n)mail carriers
man and wifehusband and wife
man enoughstrong enough
mankindhuman kind
manmademanufactured
manpowerpersonnel
men and girlsmen and women
middle(?:m[ae]n|wom[ae]n)intermediary
news(?:m[ae]n|wom[ae]n)journalist(s)
ombuds(?:man|woman)ombuds
oneupmanshipupstaging
poetesspoet
police(?:m[ae]n|wom[ae]n)police officer(s)
repair(?:m[ae]n|wom[ae]n)technician(s)
sales(?:m[ae]n|wom[ae]n)salesperson or sales people
service(?:m[ae]n|wom[ae]n)soldier(s)
steward(?:ess)?flight attendant
tribes(?:m[ae]n|wom[ae]n)tribe member(s)
waitresswaiter
woman doctordoctor
woman scientist[s]?scientist(s)
work(?:m[ae]n|wom[ae]n)worker(s)

More information ->

Grafana.GoogleLyHyphens

Extends: existence

<CURRENT TEXT> doesn’t need a hyphen.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \s[^\s-]+ly-

More information ->

Grafana.GoogleOptionalPlurals

Extends: existence

Don’t use plurals in parentheses such as in <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \b\w+\(s\)

More information ->

Grafana.GooglePeriods

Extends: existence

Don’t use periods with acronyms or initialisms such as <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \b(?:[A-Z]\.){3,}

More information ->

Grafana.GoogleSlang

Extends: existence

Don’t use internet slang abbreviations such as <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • tl;dr
  • ymmv
  • rtfm
  • imo
  • fwiw

More information ->

Grafana.GoogleSpacing

Extends: existence

<CURRENT TEXT> should have one space.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • [a-z][.?!] {2,}[A-Z]
  • [a-z][.?!][A-Z]

More information ->

Grafana.Latin

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
e\.?g[,.]?for example
i\.?e[,.]?that is

More information ->

Grafana.Ordinal

Extends: existence

For ordinals, write out first through ninth. For 10th on, use numerals.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • 1st
  • 2nd
  • 3rd
  • 4th
  • 5th
  • 6th
  • 7th
  • 8th
  • 9th

More information ->

Grafana.Please

Extends: existence

It’s great to be polite, but using ‘please’ in a set of instructions is overdoing the politeness.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • please

More information ->

Grafana.ReferTo

Extends: substitution

When linking in Markdown, use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
Check out \[Refer to [
See \[Refer to [
check out \[refer to [
see \[refer to [

More information ->

Grafana.RepeatedWords

Extends: repetition

<CURRENT TEXT> is repeated

Grafana.Spelling

Extends: spelling

Did you really mean <CURRENT TEXT>?

The Grafana dictionary might not know of this word yet.

To add a new word, refer to Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you.

For UI elements, use bold formatting. The spell checker doesn’t check words with bold formatting.

For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use code formatting. The spell checker doesn’t check words with code formatting.

Warnings

The following rules are warnings and may need to be fixed or otherwise require consideration.

Grafana.Admin

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> unless it’s the name of the UI label like in the Grafana ‘Admin’ role.

Current textReplacement text
adminadministrator

More information ->

Grafana.Admonitions

Extends: script

Prefer the admonition shortcode over blockquotes.

The admonition shortcode renders its content in a blockquote with consistent styling across the website.

More information ->

Grafana.Agentless

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Grafana Agent has been replaced by Grafana Alloy, so you shouldn’t use agent-based terminology.

If you’re talking about why and how to send signals directly from an application to Grafana Cloud, prefer no-collector to agentless.

This is consistent with OTel documentation.

Current textReplacement text
agentlessno-collector

More information ->

Grafana.AllowsTo

Extends: substitution

Did you mean <REPLACEMENT TEXT> instead of <CURRENT TEXT>?

Allows to is a common wording error.

Current textReplacement text
allows toallows you to|makes it possible to

Grafana.AltText

Extends: script

All images must have alt text.

More information ->

Grafana.AmazonCloudWatch

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
AWS CloudWatchAmazon CloudWatch
CloudwatchCloudWatch
aws CloudWatchAmazon CloudWatch
cloudWatchCloudWatch
cloudwatchCloudWatch

More information ->

Grafana.AmazonProductNames

Extends: conditional

Use the full Amazon product name in the first instance.

More information ->

Grafana.AndOr

Extends: existence

Avoid writing and/or except when space is limited, such as in tables.

Often, ‘and’ implies ‘or’, so you don’t need to write both words.

If you need to specify both in your content, write something like “You can export raw events, processed events, or both.”

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • and/or

More information ->

Grafana.ApacheProjectNames

Extends: conditional

Use the full Apache project name in the first instance.

More information ->

Grafana.CHANGELOG

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> unless you’re referring to a specific file which has that spelling.

Current textReplacement text
[Cc]hangelogCHANGELOG
[Cc]hangelog\.mdCHANGELOG.md
[Cc]hangelogsCHANGELOGs

More information ->

Grafana.CommandLinePrompts

Extends: script

Don’t add $ or # as prompts before commands. Make it easy for users to copy and paste commands.

Also, don’t use # to include comments in commands. That explanation should be outside of the code block.

More information ->

Grafana.DatadogProxy

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
Datadog ProxyDatadog proxy
[tT]he [Dd]atadog proxyDatadog proxy

Grafana.DialogBox

Extends: substitution

Use <REPLACEMENT TEXT> rather than <CURRENT TEXT>.

Current textReplacement text
dialog box appearsdialog box opens
dialog(?! box)dialog box
modaldialog box

More information ->

Grafana.DocumentationTeam

Extends: substitution

Use <REPLACEMENT TEXT> rather than <CURRENT TEXT>.

Current textReplacement text
[Dd]ocs? (?:[Ss]quad|[Tt]eam)the Grafana Labs documentation team
[Dd]ocumentation (?:[Ss]quad|Team)the Grafana Labs documentation team

Grafana.EndToEnd

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
[eE]2[eE]end-to-end

More information ->

Grafana.Exclamation

Extends: existence

Avoid exclamation points in text, except in rare really exciting moments.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \w+!(?:\s|$)

More information ->

Grafana.Gerunds

Extends: script

For a task-based heading, start with a bare infinitive, also known as a plain form or base form verb. In English, the imperative mood also uses the base form verb, so it looks the same as the bare infinitive.

Task-based headings are frequently used in quickstarts, how-to documents, and tutorials.

For a conceptual or non-task-based heading, use a noun phrase that doesn’t start with an -ing verb.

Noun-phrase headings are frequently used in concept documentation.

More information ->

Grafana.GoogleEllipses

Extends: existence

In general, don’t use an ellipsis.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \.\.\.

More information ->

Grafana.GoogleFirstPerson

Extends: existence

Avoid first-person pronouns such as <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • (?:^|\s)I\s
  • (?:^|\s)I,\s
  • \bI'm\b
  • \bme\b
  • \bmy\b
  • \bmine\b

More information ->

Grafana.GoogleHeadingPunctuation

Extends: existence

Don’t put a period at the end of a heading.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • [a-z0-9][.]\s*$

More information ->

Grafana.GoogleProductNames

Extends: conditional

Use the full Google product name in the first instance.

More information ->

Grafana.GoogleRanges

Extends: existence

Don’t add words such as ‘from’ or ‘between’ to describe a range of numbers.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • (?:from|between)\s\d+\s?-\s?\d+

More information ->

Grafana.GoogleSpelling

Extends: existence

In general, use American spelling instead of <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • (?:\w+)nised?
  • colour
  • labour
  • centre

More information ->

Grafana.GoogleWill

Extends: existence

Avoid using <CURRENT TEXT>.

Use present tense for statements that describe general behavior that’s not associated with a particular time.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • will

More information ->

Grafana.Headings

Extends: capitalization

Use sentence-style capitalization for <CURRENT TEXT>.

If your heading contains capitalized words that represent product names, you need to add those words as exceptions in https://github.com/grafana/writers-toolkit/blob/main/vale/Grafana/Headings.yml for them to be considered correctly cased.

Vale considers multi-word exceptions such as Grafana Enterprise Metrics as a single correctly cased word.

More information ->

Grafana.Kubernetes

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
[Kk]ubectlkubectl
[Kk]ubeletkubelet
[Kk]ubernetes deploymentKubernetes Deployment
cron jobCronJob
d[ae][ae]mon[Ss]etDaemonSet
podPod
replica[Ss]etReplicaSet
stateful[Ss]etStatefulSet

More information ->

Grafana.MetaMonitoring

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
meta ?monitoringmeta-monitoring

More information ->

Grafana.OK

Extends: existence

Don’t use any variation of okay in prose. The exceptions are when you’re referencing or quoting:

  • A user interface
  • HTTP status codes or other code

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • O.K.
  • OK
  • ok
  • Ok
  • Okay
  • okay
  • A-OK
  • hokay
  • k
  • keh
  • kk
  • M'kay
  • oka
  • okeh
  • Okie dokie
  • Okily Dokily

More information ->

Grafana.ProductPossessives

Extends: existence

Don’t form a possessive from a feature name, product name, or trademark, regardless of who owns it. Instead, use the name as a modifier or rewrite to use a word like of to indicate the relationship.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • AI Observability's
  • Agent's
  • Alloy's
  • Asserts'
  • AWS's
  • Beyla's
  • CentOS's
  • CloudWatch's
  • Codespaces'
  • Data Firehose's
  • Databricks'
  • Datadog's
  • Dynatrace's
  • EKS's
  • Elastic Kubernetes Service's
  • Firehose's
  • GEM's
  • GKE's
  • Git's
  • GitHub's
  • GNU's
  • Grafana's
  • Gravatar's
  • Graylog's
  • IBM's
  • Jaeger's
  • Jira's
  • Jsonnet's
  • Kibana's
  • Killercoda's
  • Kinesis'
  • Kubernetes'
  • Kubernetes Engine's
  • LangChain's
  • Loki's
  • Markdown's
  • Memcached's
  • Mesos'
  • Mimir's
  • Moodle's
  • MySQL's
  • Okta's
  • OnCall's
  • OpenAI's
  • OpenShift's
  • OpenTelemetry's
  • OTel's
  • Parca's
  • Phlare's
  • Pinecone's
  • Podman's
  • Postgres'
  • PostgreSQL's
  • Prometheus'
  • Promtail's
  • Pyroscope's
  • RCA workbench's
  • RDS's
  • Relational Database Service's
  • React's
  • Redis'
  • Rollup's
  • Splunk's
  • Tempo's
  • Thanos'
  • Velero's
  • Vite's
  • VMware's
  • WildFly's
  • windows_exporter's
  • Zipkin's

More information ->

Grafana.PrometheusExporters

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
[Nn]ode exporterNode Exporter

More information ->

Grafana.Quickstart

Extends: substitution

Use the compound adjective <REPLACEMENT TEXT> without a hyphen instead of <CURRENT TEXT> whether the noun is implied or explicit. For example, you can use quickstart guide or just quickstart.

Current textReplacement text
quick startquickstart

More information ->

Grafana.README

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> unless you’re referring to a specific file which has that spelling.

Current textReplacement text
[Rr]eadmeREADME
[Rr]eadme\.mdREADME.md
[Rr]eadmesREADMEs

More information ->

Grafana.React

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
[Rr]eact[. ]?[Jj][Ss]React

More information ->

Grafana.SQL

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

The article—a or an—that you use before the acronym SQL depends on how the word is pronounced.

When referring to the product Microsoft SQL Server, SQL should be pronounced “sequel”. In this case, use the article ‘a’, as in “a SQL Server analysis”.

When referring to the term in any other context, such as SQL databases, errors, or servers, SQL should be pronounced “ess-cue-el”. In this case, use the article ‘an’, as in “an SQL error”.

Current textReplacement text
[Aa] SQL serveran SQL server|a SQL Server
[Aa] SQL(?! [Ss]erver)an SQL
[Aa]n SQL Servera SQL Server

More information ->

Grafana.SelfManaged

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> when talking about Grafana deployment methods.

Current textReplacement text
on-prem(?:ise)?self-managed
self-hostedself-managed

More information ->

Grafana.Shortcodes

Extends: script

Prefer {{< and >}} instead of {{% and %}}

It has the most consistent semantics.

The percent syntax is used for special behavior that isn’t required with this shortcode.

More information ->

Grafana.SmartQuotes

Extends: script

Avoid smart quotes in the source file, especially in code blocks.

Replace all smart double quotes like or with ". Replace all smart single quotes like , , or ʼ with '.

In some contexts, Unicode characters aren’t supported and break configurations.

The website renders paired quotes using smart quotes in paragraphs.

Grafana.We

Extends: existence

Use first person plural pronouns like <CURRENT TEXT> carefully.

Don’t use ‘we’ when you’re talking about the reader, instead use ‘you’.

It’s OK to use ‘we’ when you’re talking about Grafana Labs.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • we
  • we'(?:ve|re)
  • ours?
  • us
  • let's

More information ->

Grafana.Wish

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
wishneed|want

More information ->

Grafana.WordList

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
(?:(?<!Data )Firehose|Kinesis Data Firehose|Kinesis Firehose)Data Firehose
(?:SHA-1|HAS-SHA1)SHA-1
(?:WiFi|wifi)Wi-Fi
(?:[Oo]penshift|openShift)OpenShift
(?:[gG]itHub]|Github)GitHub
(?:[oO]pentelemetry|openTelemetry)OpenTelemetry
(?:alert[Mm]anager|[Aa]lert [Mm]anager|AlertManager)Alertmanager
(?:cell ?phone|smart ?phone)phone|mobile phone
(?:content|media)-?typemedia type
(?:e-mail|Email|E-mail)email
(?:file ?path|path ?name)path
(?:file ?path|path ?name)spaths
(?:hamburger menu|kebab menu)menu icon
(?:kill|terminate|abort)stop|exit|cancel|end
(?<!kube-)prometheusPrometheus
(?<!lambda-)promtailPromtail
GMEGEM
Grafana AI observabilityGrafana AI Observability
HTTPsHTTPS
OnceAfter
RCA WorkbenchRCA workbench
VMWareVMware
VmwareVMware
[Ww]orld [Ww]ide [Ww]ebweb
[cC]entosCentOS
\b(?:[aA]daptive metrics|adaptive Metrics)\bAdaptive Metrics
ad[- ]?hocfree-form|user-written
back[ -]endbackend
blacklistblocklist
blacklistedblocklisted
blacklistingblocklisting
blacklistsblocklists
check[- ]boxcheckbox
content typemedia type
data-?sourcedata source
data-?sourcesdata sources
data[- ]?setdataset
data[- ]?setsdatasets
datacenterdata center
datacentersdata centers
de-duplicatededuplicate
de-duplicateddeduplicated
de-duplicatesdeduplicates
de-duplicationdeduplication
fewer dataless data
file namefilename
file namesfilenames
firewallsfirewall rules
front[ -]endfrontend
front[ -]endsfrontends
gitGit
grafanaGrafana
grayed-outunavailable
in order toto
jsonnetJsonnet
langchainLangChain
left[- ]hand[- ]sideleft-side
log(?:ql|QL)LogQL
lokiLoki
markdownMarkdown
memcachedMemcached
meta[- ]datametadata
mix[- ]inmixin
mysqlMySQL
network IP addressinternal IP address
open-sourceopen source
otelOTel
phlarePhlare
postgresPostgres
postgresqlPostgreSQL
prom(?:ql|QL)PromQL
redisRedis
regex[ep]?sregular expression
regexp?regular expression
reporepository
reposrepositories
right[- ]hand[- ]sideright-side
sign intosign in to
sqliteSQLite
style sheetstylesheet
style sheetsstylesheet
synchsync
synchedsynced
synchingsyncing
tempoTempo
the Grafana AgentGrafana Agent
the RCA [Ww]orkbenchRCA workbench
timeseriestime series|time-series
trace(?:ql|QL)TraceQL
un(?:check|select)clear
urlURL
urlsURLs
vmwareVMware
vs\.versus
whitelistallowlist
whitelistedallowlisted
whitelistingallowlisting
whitelistsallowlists

More information ->

Suggestions

The following rules are suggestions to consider a certain point of style.

Grafana.Acronyms

Extends: conditional

Spell out <CURRENT TEXT>, if it’s unfamiliar to the audience.

More information ->

Grafana.Archives

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
[Uu]n(?:archive|compress|tar|zip)extract
[Zz][Ii][Pp](?: file)?archive|compressed file
unzipextract

More information ->

Grafana.DropDown

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Use drop-down as a modifier rather than as a standalone noun. For example: drop-down menu.

Current textReplacement text
drop ?downdrop-down

More information ->

Grafana.GoogleContractions

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
are notaren't
cannotcan't
could notcouldn't
did notdidn't
do notdon't
does notdoesn't
has nothasn't
have nothaven't
how ishow's
is notisn't
it isit's
should notshouldn't
that isthat's
they arethey're
was notwasn't
we arewe're
we havewe've
were notweren't
what iswhat's
when iswhen's
where iswhere's
will notwon't

More information ->

Grafana.GoogleOxfordComma

Extends: existence

Use the Oxford comma in <CURRENT TEXT>.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • (?:[^,]+,){1,}\s\w+\s(?:and|or)

More information ->

Grafana.GooglePassive

Extends: existence

In general, use active voice instead of passive voice (<CURRENT TEXT>).

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • [\w]+ed
  • awoken
  • beat
  • become
  • been
  • begun
  • bent
  • beset
  • bet
  • bid
  • bidden
  • bitten
  • bled
  • blown
  • born
  • bought
  • bound
  • bred
  • broadcast
  • broken
  • brought
  • built
  • burnt
  • burst
  • cast
  • caught
  • chosen
  • clung
  • come
  • cost
  • crept
  • cut
  • dealt
  • dived
  • done
  • drawn
  • dreamt
  • driven
  • drunk
  • dug
  • eaten
  • fallen
  • fed
  • felt
  • fit
  • fled
  • flown
  • flung
  • forbidden
  • foregone
  • forgiven
  • forgotten
  • forsaken
  • fought
  • found
  • frozen
  • given
  • gone
  • gotten
  • ground
  • grown
  • heard
  • held
  • hidden
  • hit
  • hung
  • hurt
  • kept
  • knelt
  • knit
  • known
  • laid
  • lain
  • leapt
  • learnt
  • led
  • left
  • lent
  • let
  • lighted
  • lost
  • made
  • meant
  • met
  • misspelt
  • mistaken
  • mown
  • overcome
  • overdone
  • overtaken
  • overthrown
  • paid
  • pled
  • proven
  • put
  • quit
  • read
  • rid
  • ridden
  • risen
  • run
  • rung
  • said
  • sat
  • sawn
  • seen
  • sent
  • set
  • sewn
  • shaken
  • shaven
  • shed
  • shod
  • shone
  • shorn
  • shot
  • shown
  • shrunk
  • shut
  • slain
  • slept
  • slid
  • slit
  • slung
  • smitten
  • sold
  • sought
  • sown
  • sped
  • spent
  • spilt
  • spit
  • split
  • spoken
  • spread
  • sprung
  • spun
  • stolen
  • stood
  • stridden
  • striven
  • struck
  • strung
  • stuck
  • stung
  • stunk
  • sung
  • sunk
  • swept
  • swollen
  • sworn
  • swum
  • swung
  • taken
  • taught
  • thought
  • thrived
  • thrown
  • thrust
  • told
  • torn
  • trodden
  • understood
  • upheld
  • upset
  • wed
  • wept
  • withheld
  • withstood
  • woken
  • won
  • worn
  • wound
  • woven
  • written
  • wrung

More information ->

Grafana.GoogleSemicolons

Extends: existence

Use semicolons judiciously.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • ;

More information ->

Grafana.OAuth

Extends: substitution

Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.

Current textReplacement text
O[Aa]uth 2(?!\.0)OAuth 2.0
O[Aa]uth(?! 2\.0)OAuth 2.0

More information ->

Grafana.Parentheses

Extends: existence

Use parentheses judiciously.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • \(.{4,}\)

More information ->

Grafana.ReadabilityAutomatedReadability

Extends: metric

<CURRENT TEXT> aim for below 8.

More information ->

Grafana.ReadabilityColemanLiau

Extends: metric

<CURRENT TEXT> aim for below 9.

More information ->

Grafana.ReadabilityFleschKincaid

Extends: metric

<CURRENT TEXT> aim for below 8.

More information ->

Grafana.ReadabilityFleschReadingEase

Extends: metric

<CURRENT TEXT> aim for above 70.

More information ->

Grafana.ReadabilityGunningFog

Extends: metric

<CURRENT TEXT> aim for below 10.

More information ->

Grafana.ReadabilityLIX

Extends: metric

<CURRENT TEXT> aim for below 35.

More information ->

Grafana.ReadabilitySMOG

Extends: metric

<CURRENT TEXT> aim for below 10.

More information ->

Grafana.Timeless

Extends: existence

Avoid using <CURRENT TEXT> to keep the documentation timeless.

In general, document the current version of a product or feature.

It reduces the maintenance required to keep documentation up to date. It avoids assuming the reader is familiar with earlier versions of the product.

If you’re writing procedural or time-stamped content such as press releases, blog posts, or release notes, such time-based words and phrases are OK.

<CURRENT TEXT> was matched by one or more of the following regular expressions:

  • as of this writing
  • currently
  • does not yet
  • eventually
  • existing
  • future
  • in the future
  • latest
  • new
  • newer
  • now
  • old
  • older
  • presently
  • at present
  • soon

More information ->