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]\.
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}
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
Grafana.GoogleEnDash
Extends: existence
Use an em dash (’—’) instead of ‘–’.
<CURRENT TEXT> was matched by one or more of the following regular expressions:
–
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/shes/he\(s\)he
Grafana.GoogleGenderBias
Extends: substitution
Consider using <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement 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) |
authoress | author |
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 lawyer | lawyer |
ladylike | courteous |
landlord | building manager |
mail(?:m[ae]n|wom[ae]n) | mail carriers |
man and wife | husband and wife |
man enough | strong enough |
mankind | human kind |
manmade | manufactured |
manpower | personnel |
men and girls | men and women |
middle(?:m[ae]n|wom[ae]n) | intermediary |
news(?:m[ae]n|wom[ae]n) | journalist(s) |
ombuds(?:man|woman) | ombuds |
oneupmanship | upstaging |
poetess | poet |
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) |
waitress | waiter |
woman doctor | doctor |
woman scientist[s]? | scientist(s) |
work(?:m[ae]n|wom[ae]n) | worker(s) |
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-
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\)
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,}
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;drymmvrtfmimofwiw
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]
Grafana.Latin
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
e\.?g[,.]? | for example |
i\.?e[,.]? | that is |
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:
1st2nd3rd4th5th6th7th8th9th
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
Grafana.ReferTo
Extends: substitution
When linking in Markdown, use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
Check out \[ | Refer to [ |
See \[ | Refer to [ |
check out \[ | refer to [ |
see \[ | refer to [ |
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 text | Replacement text |
|---|---|
admin | administrator |
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.
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 text | Replacement text |
|---|---|
agentless | no-collector |
Grafana.AllowsTo
Extends: substitution
Did you mean <REPLACEMENT TEXT> instead of <CURRENT TEXT>?
Allows to is a common wording error.
| Current text | Replacement text |
|---|---|
allows to | allows you to|makes it possible to |
Grafana.AltText
Extends: script
All images must have alt text.
Grafana.AmazonCloudWatch
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
AWS CloudWatch | Amazon CloudWatch |
Cloudwatch | CloudWatch |
aws CloudWatch | Amazon CloudWatch |
cloudWatch | CloudWatch |
cloudwatch | CloudWatch |
Grafana.AmazonProductNames
Extends: conditional
Use the full Amazon product name in the first instance.
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
Grafana.ApacheProjectNames
Extends: conditional
Use the full Apache project name in the first instance.
Grafana.CHANGELOG
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> unless you’re referring to a specific file which has that spelling.
| Current text | Replacement text |
|---|---|
[Cc]hangelog | CHANGELOG |
[Cc]hangelog\.md | CHANGELOG.md |
[Cc]hangelogs | CHANGELOGs |
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.
Grafana.DatadogProxy
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
Datadog Proxy | Datadog proxy |
[tT]he [Dd]atadog proxy | Datadog proxy |
Grafana.DialogBox
Extends: substitution
Use <REPLACEMENT TEXT> rather than <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
dialog box appears | dialog box opens |
dialog(?! box) | dialog box |
modal | dialog box |
Grafana.DocumentationTeam
Extends: substitution
Use <REPLACEMENT TEXT> rather than <CURRENT TEXT>.
| Current text | Replacement 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 text | Replacement text |
|---|---|
[eE]2[eE] | end-to-end |
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|$)
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.
Grafana.GoogleEllipses
Extends: existence
In general, don’t use an ellipsis.
<CURRENT TEXT> was matched by one or more of the following regular expressions:
\.\.\.
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
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*$
Grafana.GoogleProductNames
Extends: conditional
Use the full Google product name in the first instance.
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+
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?colourlabourcentre
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
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.
Grafana.Kubernetes
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
[Kk]ubectl | kubectl |
[Kk]ubelet | kubelet |
[Kk]ubernetes deployment | Kubernetes Deployment |
cron job | CronJob |
d[ae][ae]mon[Ss]et | DaemonSet |
pod | Pod |
replica[Ss]et | ReplicaSet |
stateful[Ss]et | StatefulSet |
Grafana.MetaMonitoring
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
meta ?monitoring | meta-monitoring |
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.OKokOkOkayokayA-OKhokaykkehkkM'kayokaokehOkie dokieOkily Dokily
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'sAgent'sAlloy'sAsserts'AWS'sBeyla'sCentOS'sCloudWatch'sCodespaces'Data Firehose'sDatabricks'Datadog'sDynatrace'sEKS'sElastic Kubernetes Service'sFirehose'sGEM'sGKE'sGit'sGitHub'sGNU'sGrafana'sGravatar'sGraylog'sIBM'sJaeger'sJira'sJsonnet'sKibana'sKillercoda'sKinesis'Kubernetes'Kubernetes Engine'sLangChain'sLoki'sMarkdown'sMemcached'sMesos'Mimir'sMoodle'sMySQL'sOkta'sOnCall'sOpenAI'sOpenShift'sOpenTelemetry'sOTel'sParca'sPhlare'sPinecone'sPodman'sPostgres'PostgreSQL'sPrometheus'Promtail'sPyroscope'sRCA workbench'sRDS'sRelational Database Service'sReact'sRedis'Rollup'sSplunk'sTempo'sThanos'Velero'sVite'sVMware'sWildFly'swindows_exporter'sZipkin's
Grafana.PrometheusExporters
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
[Nn]ode exporter | Node Exporter |
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 text | Replacement text |
|---|---|
quick start | quickstart |
Grafana.README
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> unless you’re referring to a specific file which has that spelling.
| Current text | Replacement text |
|---|---|
[Rr]eadme | README |
[Rr]eadme\.md | README.md |
[Rr]eadmes | READMEs |
Grafana.React
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
[Rr]eact[. ]?[Jj][Ss] | React |
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 text | Replacement text |
|---|---|
[Aa] SQL server | an SQL server|a SQL Server |
[Aa] SQL(?! [Ss]erver) | an SQL |
[Aa]n SQL Server | a SQL Server |
Grafana.SelfManaged
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT> when talking about Grafana deployment methods.
| Current text | Replacement text |
|---|---|
on-prem(?:ise)? | self-managed |
self-hosted | self-managed |
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.
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:
wewe'(?:ve|re)ours?uslet's
Grafana.Wish
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
wish | need|want |
Grafana.WordList
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement 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)-?type | media type |
(?:e-mail|Email|E-mail) | email |
(?:file ?path|path ?name) | path |
(?:file ?path|path ?name)s | paths |
(?:hamburger menu|kebab menu) | menu icon |
(?:kill|terminate|abort) | stop|exit|cancel|end |
(?<!kube-)prometheus | Prometheus |
(?<!lambda-)promtail | Promtail |
GME | GEM |
Grafana AI observability | Grafana AI Observability |
HTTPs | HTTPS |
Once | After |
RCA Workbench | RCA workbench |
VMWare | VMware |
Vmware | VMware |
[Ww]orld [Ww]ide [Ww]eb | web |
[cC]entos | CentOS |
\b(?:[aA]daptive metrics|adaptive Metrics)\b | Adaptive Metrics |
ad[- ]?hoc | free-form|user-written |
back[ -]end | backend |
blacklist | blocklist |
blacklisted | blocklisted |
blacklisting | blocklisting |
blacklists | blocklists |
check[- ]box | checkbox |
content type | media type |
data-?source | data source |
data-?sources | data sources |
data[- ]?set | dataset |
data[- ]?sets | datasets |
datacenter | data center |
datacenters | data centers |
de-duplicate | deduplicate |
de-duplicated | deduplicated |
de-duplicates | deduplicates |
de-duplication | deduplication |
fewer data | less data |
file name | filename |
file names | filenames |
firewalls | firewall rules |
front[ -]end | frontend |
front[ -]ends | frontends |
git | Git |
grafana | Grafana |
grayed-out | unavailable |
in order to | to |
jsonnet | Jsonnet |
langchain | LangChain |
left[- ]hand[- ]side | left-side |
log(?:ql|QL) | LogQL |
loki | Loki |
markdown | Markdown |
memcached | Memcached |
meta[- ]data | metadata |
mix[- ]in | mixin |
mysql | MySQL |
network IP address | internal IP address |
open-source | open source |
otel | OTel |
phlare | Phlare |
postgres | Postgres |
postgresql | PostgreSQL |
prom(?:ql|QL) | PromQL |
redis | Redis |
regex[ep]?s | regular expression |
regexp? | regular expression |
repo | repository |
repos | repositories |
right[- ]hand[- ]side | right-side |
sign into | sign in to |
sqlite | SQLite |
style sheet | stylesheet |
style sheets | stylesheet |
synch | sync |
synched | synced |
synching | syncing |
tempo | Tempo |
the Grafana Agent | Grafana Agent |
the RCA [Ww]orkbench | RCA workbench |
timeseries | time series|time-series |
trace(?:ql|QL) | TraceQL |
un(?:check|select) | clear |
url | URL |
urls | URLs |
vmware | VMware |
vs\. | versus |
whitelist | allowlist |
whitelisted | allowlisted |
whitelisting | allowlisting |
whitelists | allowlists |
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.
Grafana.Archives
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
[Uu]n(?:archive|compress|tar|zip) | extract |
[Zz][Ii][Pp](?: file)? | archive|compressed file |
unzip | extract |
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 text | Replacement text |
|---|---|
drop ?down | drop-down |
Grafana.GoogleContractions
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
are not | aren't |
cannot | can't |
could not | couldn't |
did not | didn't |
do not | don't |
does not | doesn't |
has not | hasn't |
have not | haven't |
how is | how's |
is not | isn't |
it is | it's |
should not | shouldn't |
that is | that's |
they are | they're |
was not | wasn't |
we are | we're |
we have | we've |
were not | weren't |
what is | what's |
when is | when's |
where is | where's |
will not | won't |
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)
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]+edawokenbeatbecomebeenbegunbentbesetbetbidbiddenbittenbledblownbornboughtboundbredbroadcastbrokenbroughtbuiltburntburstcastcaughtchosenclungcomecostcreptcutdealtdiveddonedrawndreamtdrivendrunkdugeatenfallenfedfeltfitfledflownflungforbiddenforegoneforgivenforgottenforsakenfoughtfoundfrozengivengonegottengroundgrownheardheldhiddenhithunghurtkeptkneltknitknownlaidlainleaptlearntledleftlentletlightedlostmademeantmetmisspeltmistakenmownovercomeoverdoneovertakenoverthrownpaidpledprovenputquitreadridriddenrisenrunrungsaidsatsawnseensentsetsewnshakenshavenshedshodshoneshornshotshownshrunkshutslainsleptslidslitslungsmittensoldsoughtsownspedspentspiltspitsplitspokenspreadsprungspunstolenstoodstriddenstrivenstruckstrungstuckstungstunksungsunksweptswollenswornswumswungtakentaughtthoughtthrivedthrownthrusttoldtorntroddenunderstoodupheldupsetwedweptwithheldwithstoodwokenwonwornwoundwovenwrittenwrung
Grafana.GoogleSemicolons
Extends: existence
Use semicolons judiciously.
<CURRENT TEXT> was matched by one or more of the following regular expressions:
;
Grafana.OAuth
Extends: substitution
Use <REPLACEMENT TEXT> instead of <CURRENT TEXT>.
| Current text | Replacement text |
|---|---|
O[Aa]uth 2(?!\.0) | OAuth 2.0 |
O[Aa]uth(?! 2\.0) | OAuth 2.0 |
Grafana.Parentheses
Extends: existence
Use parentheses judiciously.
<CURRENT TEXT> was matched by one or more of the following regular expressions:
\(.{4,}\)
Grafana.ReadabilityAutomatedReadability
Extends: metric
<CURRENT TEXT> aim for below 8.
Grafana.ReadabilityColemanLiau
Extends: metric
<CURRENT TEXT> aim for below 9.
Grafana.ReadabilityFleschKincaid
Extends: metric
<CURRENT TEXT> aim for below 8.
Grafana.ReadabilityFleschReadingEase
Extends: metric
<CURRENT TEXT> aim for above 70.
Grafana.ReadabilityGunningFog
Extends: metric
<CURRENT TEXT> aim for below 10.
Grafana.ReadabilityLIX
Extends: metric
<CURRENT TEXT> aim for below 35.
Grafana.ReadabilitySMOG
Extends: metric
<CURRENT TEXT> aim for below 10.
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 writingcurrentlydoes not yeteventuallyexistingfuturein the futurelatestnewnewernowoldolderpresentlyat presentsoon
Last reviewed: September 19, 2024
