Vale CMS Need more than a rule playground? Explore

Open-source project

Grafana Writers’ Toolkit

79 rules across 8 topics, naming 318 terms.

  • 19 errors
  • 42 warnings
  • 18 suggestions
The guide
grafana.com
Read at
1e58a17
License
Apache-2.0
Used by
1 of 355 public configs

The guide, by topic

Select a rule to see what it asks for.

Word choice

42 rules · preferred terms, jargon, and words to avoid

Concision

8 rules · long sentences, filler, and wordy phrases

Voice and tone

6 rules · person, tense, contractions, and claims

Inclusive language

2 rules · gendered, ableist, and loaded terms

Punctuation

11 rules · commas, dashes, quotes, and spacing

Headings

3 rules · capitalization and punctuation in titles

Numbers and dates

4 rules · dates, times, units, and ordinals

Abbreviations

3 rules · acronyms, latin, and periods

The word list

Every term this guide’s rules name, and what it says to write instead.

Instead ofWrite
1stAvoid it
2ndAvoid it
3rdAvoid it
4thAvoid it
5thAvoid it
6thAvoid it
7thAvoid it
8thAvoid it
9thAvoid it
A-OKAvoid it
adminadministrator
ADOT'sAvoid it
Agent'sAvoid it
agentlessno-collector
AI Observability'sAvoid it
allows toallows you to
Alloy'sAvoid it
alumnaegraduates
alumnusgraduate
and/orAvoid it
Apollo'sAvoid it
are notaren't
ARN'sAvoid it
as of this writingAvoid it
Asserts'Avoid it
at presentAvoid it
Atlassian'sAvoid it
authoressauthor
AWS CloudWatchAmazon CloudWatch
AWS Distro for OpenTelemetry Collector'sAvoid it
AWS X-Ray'sAvoid it
AWS'sAvoid it
Beyla'sAvoid it
blacklistblocklist
blacklistedblocklisted
blacklistingblocklisting
blacklistsblocklists
BoringCrypto'sAvoid it
cadvisorcAdvisor
cannotcan't
Catchpoint'sAvoid it
CentOS'sAvoid it
centreAvoid it
ClickHouse'sAvoid it
CloudwatchCloudWatch
CloudWatch'sAvoid it
Codespaces'Avoid it
colourAvoid it
containerd'sAvoid it
content typemedia type
could notcouldn't
CPython'sAvoid it
cron jobCronJob
Crossplane'sAvoid it
currentlyAvoid it
Data Firehose'sAvoid it
Databricks'Avoid it
datacenterdata center
datacentersdata centers
Datadog ProxyDatadog proxy

These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.

All 16 guides