Skip to content

Commit

Permalink
Merge pull request #52 from DataDog/cswatt/gobwords
Browse files Browse the repository at this point in the history
adding gobwords and other cleanup
  • Loading branch information
cswatt authored Jan 24, 2024
2 parents 204e601 + cc35908 commit c4bac08
Show file tree
Hide file tree
Showing 5 changed files with 209 additions and 92 deletions.
1 change: 0 additions & 1 deletion styles/Datadog/abbreviations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ action:
swap:
'\b(?:eg|e\.g\.|eg\.)[\s,]': for example
'\b(?:ie|i\.e\.|ie\.)[\s,]': that is
'\b(?:etc)[\s\n,.]': and more
94 changes: 52 additions & 42 deletions styles/Datadog/americanspelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,46 +9,56 @@ tokens:
- '(?:\w+)logue'
- '(?:\w+)lour'
- '(?:\w+)lyse'
- '[a-zA-Z]{2,}our(?:\b|s|ed|ing)'
exceptions:
- advertise
- advise
- appraise
- apprise
- arise
- chastise
- circumcise
- clockwise
- comprise
- compromise
- concise
- counterclockwise
- demise
- despise
- devise
- disguise
- enterprise
- Enterprise
- excise
- exercise
- expertise
- franchise
- imprecise
- improvise
- incise
- likewise
- Likewise
- merchandise
- otherwise
- Otherwise
- paradise
- praise
- precise
- premise
- promise
- revise
- rise
- supervise
- surmise
- surprise
- televise
- wise
# *ise endings
- (?:A|a)dvertise
- (?:A|a)dvise
- (?:A|a)ppraise
- (?:A|a)pprise
- (?:A|a)rise
- (?:C|c)hastise
- (?:C|c)ircumcise
- (?:C|c)lockwise
- (?:C|c)omprise
- (?:C|c)ompromise
- (?:C|c)oncise
- (?:C|c)ounterclockwise
- (?:D|d)emise
- (?:D|d)espise
- (?:D|d)evise
- (?:D|d)isguise
- (?:E|e)nterprise
- (?:E|e)xcise
- (?:E|e)xercise
- (?:E|e)xpertise
- (?:F|f)ranchise
- (?:I|i)mprecise
- (?:I|i)mprovise
- (?:I|i)ncise
- (?:L|l)ikewise
- (?:M|m)erchandise
- (?:N|n)oise
- (?:O|o)therwise
- (?:P|p)aradise
- (?:P|p)oise
- (?:P|p)raise
- (?:P|p)recise
- (?:P|p)remise
- (?:P|p)romise
- (?:R|r)evise
- (?:R|r)ise
- (?:S|s)upervise
- (?:S|s)urmise
- (?:S|s)urprise
- (?:T|t)elevise
- (?:W|w)ise

# *our* words
- (?:d|D)etours?
- (?:c|C)ontours?
- (?:g|G)lamour
- (?:o|O)utpour
- (?:s|S)cours?
- (?:t|T)roubadours?
- (?:p|P)ompadour
11 changes: 11 additions & 0 deletions styles/Datadog/autodiscovery.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: substitution
message: "Use %s (the former, to refer to Datadog's mechanism for applying integration configurations to containers; the latter, to refer to automatic discovery IN GENERAL) instead of '%s'."
link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#words-and-phrases'
ignorecase: false
level: warning
action:
name: replace
swap:
- (?:autodiscovery|auto-discovery|Auto-discovery) : Autodiscovery|automatic detection
- (?:autodiscover|auto-discover|Auto-discover): Autodiscover|automatically detect
- (?:autodiscovered|auto-discovered|Auto-discovered): Autodiscovered|automatically detected
9 changes: 9 additions & 0 deletions styles/Datadog/time.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Format times as 'HOUR:MINUTE a.m.' or HOUR:MINUTE p.m.' instead of '%s'."
link: "https://datadoghq.atlassian.net/wiki/spaces/WRIT/pages/2732523547/Style+guide#%s"
level: warning
nonword: true
tokens:
- (1[012]|[1-9]):[0-5][0-9] (A\.M\.|P\.M\.)
- (1[012]|[1-9]):[0-5][0-9] (?i)(a\.m[^\.]|p\.m[^\.])
- (1[012]|[1-9]):[0-5][0-9][ ]?(?i)(am|pm)
186 changes: 137 additions & 49 deletions styles/Datadog/words.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,52 +7,140 @@ action:
name: replace
swap:
# bad: good
'acknowledgement': 'acknowledgment'
'auto-complete': 'autocomplete'
'a number of': 'few|several|many'
'and/or': 'and|or|either or'
'back end': 'backend'
'bear in mind': 'keep in mind'
'Create a new': 'Create a|Create an'
'culprit': 'cause'
'(?:Datadog app|Datadog application)': 'Datadog|Datadog site'
'Datadog product': 'Datadog|Datadog service'
'drill down|drilling down|drill into|drilling into': 'examine|investigate|analyze'
'figure out': 'determine'
'fine tune|fine-tune': 'customize|optimize|refine'
'for the most part': 'generally|usually'
'front end': 'frontend'
'highly|very': ''
'hit': 'click|select'
'in order to': 'to'
'keep in mind': 'consider'
'left up to': 'determined by'
"let's assume": 'assuming|for example, if'
'multi-alert': 'multi alert'
'Note that': '**Note**:'
'obviously|obvious': ''
'on the fly': 'real-time|real time'
'once': 'after'
'play a hand': 'influence'
'please|just': ''
'easily|easy': ''
'quickly|quick': ''
'screen board': 'screenboard'
'simply|simple': ''
'single pane of glass': 'single view|single place|single page'
'slice and dice': 'filter and group'
'stand for': 'represents|means'
'reenable': 're-enable'
'run time': 'runtime'
'refer to|visit': 'see|read|follow'
'time board': 'timeboard'
'time series': 'timeseries'
'toplist': 'top list'
'tradeoff': 'trade-off'
'turnkey': 'ready to use'
'under the hood': ''
'utilize': 'use'
'via': 'with|through'
'visit': 'see|read'
'webserver': 'web server'
'web site': 'website'
a number of: few|several|many
acknowledgement: acknowledgment
App Analytics: Tracing without Limits™
'auto(?:\s|-)complete': autocomplete
'auto(?:\s|-)completion': autocompletion
Availability Zone: availability zone
Availability Zones: availability zones
'back(?:\s|-)end': backend
'back(?:\s|-)ends': backends
bear in mind: keep in mind
boolean: Boolean
booleans: Booleans
cheat sheet: cheetsheet
command line interface: command-line interface
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-?source: data source
data-?sources: data sources
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
'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
flame-?graph: flame graph
flame-?graphs: flame graphs
figure out: determine
figuring out: determining
'file(?:\s|-)name': filename
'file(?:\s|-)names': filenames
filesystem: file system
filesystems: file systems
'fine\s?-?tune': customize|optimize|refine
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
hone in: home in
hones in: homes in
honing in: homing in
highly: ''
hit: click|select
in order to: to
in sync: in-sync
In sync: In-sync
indices: indexes
indexation: indexing
infrastructures: infrastructure
install command: installation command
Internet: internet
(?:i/?-?o|I-?O): I/O
(?:i/?ops|I/OPS): IOPS
just: ''
keep in mind: consider
left up to: determined by
let's assume: assuming|for example, if
load-?balancing: load balancing
machine-?learning: machine learning
'micro(?:\s|-)service': microservice
'micro(?:\s|-)services': microservices
multi-?alert: multi alert
multicloud: multi-cloud
multiline: multi-line
Note that: "**Note**:"
(?:obvious|obviously|Obviously): ''
off-line: offline
on the fly: real-time|in real time
Once: After
open-?source: open source
page view: pageview
page views: pageviews
play a hand: influence
please: ''
pre-connect: preconnect
quick|quickly: ''
'screen(?:\s|-)board': screenboard
simple|simply: ''
single pane of glass: single view|single place|single page
slice and dice: filter and group
stand for: represent|mean
Synthetics: Synthetic Monitoring
reenable: re-enable
'run(?:\s|-)time': runtime
refer to|visit: see|read|follow
time board: timeboard
'time(?:\s|-)series': timeseries
time-?frame: time frame
time-?frames: time frames
top-?list: top list
'trade(?:\s|-)off': trade-off
Trace Search and Analytics: Tracing without Limits™
turnkey: ready to use
under the hood: ''
utilize: use
very: ''
via: with|through
visit: see|read
webserver: web server
web site: website
'X-?(?:A|a)xis': x-axis
'Y-?(?:A|a)xis': y-axis

# proper nouns
(?:github|Github): GitHub
(?:kubernetes|k8s|K8s|K8S): Kubernetes
(?:Mapreduce|mapreduce|Map reduce|Map Reduce): MapReduce
memcached: Memcached
(?: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

0 comments on commit c4bac08

Please sign in to comment.