Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
3 changes: 2 additions & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Datadog.pronouns = YES
Datadog.sentencelength = YES
Datadog.spaces = YES
Datadog.tense = YES
Datadog.words = YES
Datadog.words_case_sensitive = YES
Datadog.words_case_insensitive = YES
Datadog.quotes = YES
Datadog.aws = YES
8 changes: 4 additions & 4 deletions styles/Datadog/Trademarks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nonword: true
# Logging without Limits\*
# Logging without Limits™
tokens:
- '(?<!\*)Logging without Limits(?!\s*(\™|\\\*|\*))'
- '(?<!\*)Tracing without Limits(?!\s*(\™|\\\*|\*))'
- '(?<!\*)Metrics without Limits(?!\s*(\™|\\\*|\*))'
- '(?<!\*)Log Rehydration(?!\s*(\™|\\\*|\*))'
- '(?<!\*)Logging without Limits(?!\s*(™|\\\*|\*))'
- '(?<!\*)Tracing without Limits(?!\s*(™|\\\*|\*))'
- '(?<!\*)Metrics without Limits(?!\s*(™|\\\*|\*))'
- '(?<!\*)Log Rehydration(?!\s*(™|\\\*|\*))'
2 changes: 1 addition & 1 deletion styles/Datadog/aws.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ swap:
AWS AppStream: Amazon AppStream
Amazon AppSync: AWS AppSync
AWS Athena: Amazon Athena
Amazon Auto Scaling: AWS Auto Scaling
'(Amazon|AWS) Auto(?:\s|-)(S|s)caling': AWS Auto Scaling
Amazon Backup: AWS Backup
AWS Bedrock: Amazon Bedrock
Amazon Certificate Manager: AWS Certificate Manager
Expand Down
4 changes: 2 additions & 2 deletions styles/Datadog/inclusive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ action:
name: replace
swap:
# bad: good
'black ?list': 'disallow list|exclude list'
'black ?list': 'blocklist|disallow list|exclude list|denylist'
'master': primary
'slave': secondary
'white ?list': 'allow list|include list'
'white ?list': 'allowlist|include list'
Original file line number Diff line number Diff line change
@@ -1,72 +1,77 @@
# This file is used to lint words and phrases that are case-insensitive.
extends: substitution
message: "Use '%s' instead of '%s'."
link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#words-and-phrases"
ignorecase: false
ignorecase: true
level: warning
action:
name: replace
swap:
# bad: good
a number of: few|several|many
acknowledgement: acknowledgment
App Analytics: Tracing without Limits™
action on: act on|take action on
afterwards: afterward
'auto(?:\s|-)complete': autocomplete
'auto(?:\s|-)completion': autocompletion
Availability Zone: availability zone
Availability Zones: availability zones
'auto(?:\s|-)scale': autoscale
'auto(?:\s|-)scaling': autoscaling
'back(?:\s|-)end': backend
'back(?:\s|-)ends': backends
baked(?:\s|-)in: ''
bear in mind: keep in mind
'best(?:\s|-)in(?:\s|-)class': leading|top|excellent
boolean: Boolean
booleans: Booleans
cheat sheet: cheatsheet
code base: codebase
command line interface: command-line interface
Create a new: Create a|Create an
create a new: create a|create an
culprit: cause
data are: data is
'data(?:\s|-)point': datapoint
'data(?:\s|-)points': datapoints
'data(?:\s|-)set': dataset
'data(?:\s|-)sets': datasets
data-?center: data center
data-?centers: data centers
'Datadog (?:app|application)': Datadog|Datadog site
Datadog product: Datadog|Datadog service
data(?:\s|-)point: datapoint
data(?:\s|-)points: datapoints
data(?:\s|-)set: dataset
data(?:\s|-)sets: datasets
data-?source: data source
data-?sources: data sources
data-?store: data store
data-?stores: data stores
default (?:dash|screen)board: out-of-the-box dashboard
default (?:dash|screen)boards: out-of-the-box dashboards
(?:Dev/?ops|dev/?ops|Dev/Ops): DevOps|DevSecOps
delve: ''
(?:disaggregate|disaggregated): filter|isolate
'drill (?:down|into)': examine|investigate|analyze
'drilling (?:down|into)': examining|investigating|analyzing
Distributed Tracing: distributed tracing
(?:easy|easily): ''
e-?book: eBook
e-?books: eBooks
e-mail: email
e-mailing: emailing
e-mails: emails
'end(?:\s|-)point': endpoint
'end(?:\s|-)points': endpoints
event (?:stream|streem): Event Stream
ensure(?:s)?: helps|helps ensure
flame-?graph: flame graph
flame-?graphs: flame graphs
figure out: determine
figuring out: determining
'file(?:\s|-)name': filename
'file(?:\s|-)names': filenames
filepath: file path
filepaths: file paths
filesystem: file system
filesystems: file systems
'fine\s?-?tune': customize|optimize|refine
firstly: first
for the most part: generally|usually
'front(?:\s|-)end': frontend
health-?check: heath check
health-?checks: heath checks
(?:heat-?map|Heat Map): heat map
(?:heat-?maps|Heat Maps): heat maps
(?:host-?map|Host Map): host map
(?:host-?maps|Host Maps): host maps
(?:health-?check): health check
(?:health-?checks): health checks
(?:heat-?map): heat map
(?:heat-?maps): heat maps
(?:host-?map): host map
(?:host-?maps): host maps
holistic: complete|comprehensive|integrated
hone in: home in
hones in: homes in
Expand All @@ -75,82 +80,95 @@ swap:
hit: click|select
in order to: to
in sync: in-sync
In sync: In-sync
indices: indexes
indexation: indexing
infrastructures: infrastructure
infrastructural: ''
install command: installation command
Internet: internet
(?:i/?-?o|I-?O): I/O
(?:i/?ops|I/OPS): IOPS
just: ''
keep in mind: consider
key/value: key-value|key:value
left up to: determined by
let's assume: assuming|for example, if
leverage: use|apply|take advantage of
lifecycle: life cycle
lifecycles: life cycles
load-?balanced: load balanced
load-?balancing: load balancing
log into: log in to
machine-?learning: machine learning
'micro(?:\s|-)service': microservice
'micro(?:\s|-)services': microservices
monolith(?:\s|-)application: monolithic application
monolith(?:\s|-)applications: monolithic applications
multi-?alert: multi alert
multicloud: multi-cloud
multiline: multi-line
multitier: multi-tier
Note that: "**Note**:"
(?:obvious|obviously|Obviously): ''
off-line: offline
'obvious(ly)?': ''
off(?:\s|-)line: offline
off(?:\s|-)board: offboard
on(?:\s|-)board: onboard
on(?:\s|-)premise: on-premises|on-prem
on the fly: real-time|in real time
Once: After
once you: after you
once the: after the
open-?source: open source
over(?:\s|-)provision: overprovision
over(?:\s|-)provisioned: overprovisioned
page view: pageview
page views: pageviews
percent: '%'
personal identifiable information: personally identifiable information
play a hand: influence
please: ''
pre-connect: preconnect
post(?:\s|-)mortem: postmortem
pre(?:\s|-)built: prebuilt
pre(?:\s|-)connect: preconnect
quick|quickly: ''
real-user monitoring: real user monitoring
'run(?:\s|-)time': runtime
refer to|visit: see|read|follow
reenable: re-enable
'screen(?:\s|-)board': screenboard
seamless|seamlessly: ''
secondly: second
service(?:\s|-)level(?:\s|-)agreement: service level agreement
service(?:\s|-)level(?:\s|-)agreements: service level agreements
service(?:\s|-)level(?:\s|-)indicator: service level indicator
service(?:\s|-)level(?:\s|-)indicators: service level indicators
service(?:\s|-)level(?:\s|-)objective: service level objective
service(?:\s|-)level(?:\s|-)objectives: service level objectives
sign into: sign in to
'state(?:\s|-)of(?:\s|-)the(?:\s|-)art': modern|current|advanced
simple|simply: ''
single pane of glass: single view|single place|single page
single pane of glass: unified view|single view|single place|single page
slice and dice: filter and group
stand for: represent|mean
'state(?:\s|-)of(?:\s|-)the(?:\s|-)art': modern|current|advanced
streamline: simplify|improve|optimize
Synthetics: Synthetic Monitoring
reenable: re-enable
'run(?:\s|-)time': runtime
refer to|visit: see|read|follow
streamline|streamlined|streamlining: simplify|improve|optimize
thirdly: third
time board: timeboard
'time(?:\s|-)series': timeseries
time-?frame: time frame
time-?frames: time frames
time-?series: timeseries
top-?list: top list
towards: toward
'trade(?:\s|-)off': trade-off
Trace Search and Analytics: Tracing without Limits™
turnkey: ready to use
turn(?:\s|-)key: turnkey|ready to use
under(?:\s|-)provision: underprovision
under the hood: ''
use-?case: use case
user-experience monitoring: user experience monitoring
unlock: enable|provide|give access to
utilize: use
very: ''
via: with|through
vibe-?code: vibe code
vibe-?coded: vibe coded
vibe-?coding: vibe coding
visit: see|read
webpage: web page
webserver: web server
web site: website
'X-axis': x-axis
'Y-axis': y-axis
'NPM': CNM
'Network Performance Monitoring': Cloud Network Monitoring


# proper nouns
(?:github|Github): GitHub
(?:kubernetes|k8s|K8s|K8S): Kubernetes
(?:Mapreduce|mapreduce|Map reduce|Map Reduce): MapReduce
memcached: Memcached
(?:netflow|Netflow): NetFlow
(?:nginx|Nginx): NGINX
(?:node.js|nodeJS|NodeJS|node.JS|Node.JS): Node.js
(?:pagerduty|pager duty|Pagerduty|Pager duty): PagerDuty
prometheus: Prometheus
(?:sql|Sql): SQL
(?:statsd|statsD|Statsd): StatsD
(?:unix|Unix): UNIX

67 changes: 67 additions & 0 deletions styles/Datadog/words_case_sensitive.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# This file is used to lint words and phrases that are case-sensitive.
extends: substitution
message: "Use '%s' instead of '%s'."
link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#words-and-phrases"
ignorecase: false
level: warning
action:
name: replace
swap:
# bad: good
Availability Zone: availability zone
Availability Zones: availability zones
boolean: Boolean
booleans: Booleans
Browser Test: browser test
Distributed Tracing: distributed tracing
e-?book: eBook
e-?books: eBooks
'e(?:\s|-)?[Cc]ommerce': ecommerce
Event Stream: event stream
(G|g)olden paths: Golden Paths
(?:Heat-?[Mm]ap): heat map
(?:Heat-?[Mm]aps): heat maps
(?:Host-?[Mm]ap): host map
(?:Host-?[Mm]aps): host maps
Internet: internet
'[Ii][-/]?[Oo]': I/O
'[Ii]/?(OPS|ops)': IOPS
Mean Time [Tt]o Acknowledge: mean time to acknowledge
Mean Time [Tt]o Detect: mean time to detect
Mean Time [Tt]o Detection: mean time to detection
Mean Time [Tt]o Resolve: mean time to resolve
Mean Time [Tt]o Resolution: mean time to resolution
Multistep API Test: multistep API test
Once: After
Performance Schema: performance schema
Security Signal: security signal
Shared Responsibility Model: shared responsibility model
Sys Schema: sys schema
'X-axis': x-axis
'Y-axis': y-axis

# proper nouns
App Analytics: Tracing without Limits™
'[Dd]ata[Dd]og': Datadog
Datadog agent: Datadog Agent
'[Dd]ev ?[Oo]ps': DevOps|DevSecOps
'[Dd]og[Ss]tats[Dd]': DogStatsD
'[Gg]it[Hh]ub': GitHub
Google Cloud Platform: Google Cloud
JIRA|jira: Jira
(kubernetes|[Kk]8[Ss]): Kubernetes
'[Mm]ap ?[Rr]educe': MapReduce
memcached: Memcached
'[Nn]et ?[Ff]low': NetFlow
'Network Performance Monitoring': Cloud Network Monitoring
'NPM': CNM
nginx|Nginx: NGINX
'[Nn]ode.?[Jj][Ss]|Node': Node.js
'[Pp]ager ?[Dd]uty': PagerDuty
prometheus: Prometheus
(?:sql|Sql): SQL
'[Ss]tats[Dd]': StatsD
Synthetics: Synthetic Monitoring
Trace Search and Analytics: Tracing without Limits™
(?:unix|Unix): UNIX
'\\*NIX': Unix-like