From edb41b8d41c71b0170c5fc3a9a5fc92d06e83c06 Mon Sep 17 00:00:00 2001 From: Janine Chan <64388808+janine-c@users.noreply.github.com> Date: Wed, 17 Sep 2025 11:52:25 -0600 Subject: [PATCH 1/8] Add and move around terms --- styles/Datadog/aws.yml | 2 +- styles/Datadog/inclusive.yml | 4 +- .../{words.yml => words_case_insensitive.yml} | 49 +++++-------------- styles/Datadog/words_case_sensitive.yml | 38 ++++++++++++++ 4 files changed, 54 insertions(+), 39 deletions(-) rename styles/Datadog/{words.yml => words_case_insensitive.yml} (76%) create mode 100644 styles/Datadog/words_case_sensitive.yml diff --git a/styles/Datadog/aws.yml b/styles/Datadog/aws.yml index 58e1b3b..86e6fb8 100644 --- a/styles/Datadog/aws.yml +++ b/styles/Datadog/aws.yml @@ -13,7 +13,7 @@ swap: AWS AppStream: Amazon AppStream Amazon AppSync: AWS AppSync AWS Athena: Amazon Athena - Amazon Auto Scaling: AWS Auto Scaling + (Amazon|AWS) (Auto Scaling|Autoscaling|Auto-scaling): AWS Auto Scaling Amazon Backup: AWS Backup AWS Bedrock: Amazon Bedrock Amazon Certificate Manager: AWS Certificate Manager diff --git a/styles/Datadog/inclusive.yml b/styles/Datadog/inclusive.yml index bc1a9df..2092bdd 100644 --- a/styles/Datadog/inclusive.yml +++ b/styles/Datadog/inclusive.yml @@ -7,7 +7,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' diff --git a/styles/Datadog/words.yml b/styles/Datadog/words_case_insensitive.yml similarity index 76% rename from styles/Datadog/words.yml rename to styles/Datadog/words_case_insensitive.yml index 1ce9b21..c840266 100644 --- a/styles/Datadog/words.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -1,7 +1,7 @@ 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 @@ -9,16 +9,16 @@ swap: # bad: good a number of: few|several|many acknowledgement: acknowledgment + action on: act on|take action on + afterwards: afterward App Analytics: Tracing without Limits™ 'auto(?:\s|-)complete': autocomplete 'auto(?:\s|-)completion': autocompletion - Availability Zone: availability zone - Availability Zones: availability zones + 'auto(?:\s|-)scale': autoscale + '(? Date: Wed, 17 Sep 2025 11:12:58 -0700 Subject: [PATCH 2/8] add desc to words case files --- styles/Datadog/words_case_insensitive.yml | 1 + styles/Datadog/words_case_sensitive.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/styles/Datadog/words_case_insensitive.yml b/styles/Datadog/words_case_insensitive.yml index c840266..951fef5 100644 --- a/styles/Datadog/words_case_insensitive.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -1,3 +1,4 @@ +# 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" diff --git a/styles/Datadog/words_case_sensitive.yml b/styles/Datadog/words_case_sensitive.yml index ab93728..7fe615b 100644 --- a/styles/Datadog/words_case_sensitive.yml +++ b/styles/Datadog/words_case_sensitive.yml @@ -1,3 +1,4 @@ +# 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" From 6af4e212c62849377e181616ff5638905920bf44 Mon Sep 17 00:00:00 2001 From: Janine Chan <64388808+janine-c@users.noreply.github.com> Date: Wed, 17 Sep 2025 12:26:44 -0600 Subject: [PATCH 3/8] Move more case-sensitive terms --- styles/Datadog/words_case_insensitive.yml | 10 +--------- styles/Datadog/words_case_sensitive.yml | 8 ++++++++ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/styles/Datadog/words_case_insensitive.yml b/styles/Datadog/words_case_insensitive.yml index 951fef5..fcbe80e 100644 --- a/styles/Datadog/words_case_insensitive.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -12,7 +12,6 @@ swap: acknowledgement: acknowledgment action on: act on|take action on afterwards: afterward - App Analytics: Tracing without Limits™ 'auto(?:\s|-)complete': autocomplete 'auto(?:\s|-)completion': autocompletion 'auto(?:\s|-)scale': autoscale @@ -22,7 +21,7 @@ swap: bear in mind: keep in mind cheat sheet: cheatsheet 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 @@ -40,8 +39,6 @@ swap: 'drill (?:down|into)': examine|investigate|analyze 'drilling (?:down|into)': examining|investigating|analyzing (?:easy|easily): '' - e-?book: eBook - e-?books: eBooks e-mail: email e-mailing: emailing e-mails: emails @@ -92,7 +89,6 @@ swap: (?:obvious|obviously): '' off-line: offline on the fly: real-time|in real time - once: after open-?source: open source page view: pageview page views: pageviews @@ -105,7 +101,6 @@ swap: 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 @@ -115,7 +110,6 @@ swap: 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 @@ -124,5 +118,3 @@ swap: visit: see|read webserver: web server web site: website - 'NPM': CNM - 'Network Performance Monitoring': Cloud Network Monitoring diff --git a/styles/Datadog/words_case_sensitive.yml b/styles/Datadog/words_case_sensitive.yml index 7fe615b..a805534 100644 --- a/styles/Datadog/words_case_sensitive.yml +++ b/styles/Datadog/words_case_sensitive.yml @@ -15,25 +15,33 @@ swap: Datadog agent: Datadog Agent (?:Dev/?ops|dev/?ops|Dev/Ops): DevOps|DevSecOps Distributed Tracing: distributed tracing + e-?book: eBook + e-?books: eBooks event (?:stream|streem): Event Stream (?:Heat-?[Mm]ap): heat map (?:Heat-?[Mm]aps): heat maps (?:Host-?[Mm]ap): host map (?:Host-?[Mm]aps): host maps Internet: internet + Once: After 'X-axis': x-axis 'Y-axis': y-axis # proper nouns + App Analytics: Tracing without Limits™ (?:github|Github): GitHub (?:kubernetes|k8s|K8s|K8S): Kubernetes (?:Mapreduce|mapreduce|Map reduce|Map Reduce): MapReduce memcached: Memcached (?:netflow|Netflow): NetFlow + 'Network Performance Monitoring': Cloud Network Monitoring + 'NPM': CNM (?: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 + Synthetics: Synthetic Monitoring + Trace Search and Analytics: Tracing without Limits™ (?:unix|Unix): UNIX \ No newline at end of file From 39cd954aef3332fe273aea57aa10c7ab56246746 Mon Sep 17 00:00:00 2001 From: Janine Chan <64388808+janine-c@users.noreply.github.com> Date: Wed, 17 Sep 2025 13:02:47 -0600 Subject: [PATCH 4/8] Add new files to .vale.ini --- .vale.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 922a5e0..38b57a4 100644 --- a/.vale.ini +++ b/.vale.ini @@ -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 \ No newline at end of file From c817460bad9e3e8400026c8f5b2eed11bb743625 Mon Sep 17 00:00:00 2001 From: Janine Chan <64388808+janine-c@users.noreply.github.com> Date: Wed, 17 Sep 2025 18:50:19 -0600 Subject: [PATCH 5/8] Finish adding word list terms --- styles/Datadog/Trademarks.yml | 8 +-- styles/Datadog/words_case_insensitive.yml | 74 +++++++++++++++++++---- styles/Datadog/words_case_sensitive.yml | 27 ++++++++- 3 files changed, 91 insertions(+), 18 deletions(-) diff --git a/styles/Datadog/Trademarks.yml b/styles/Datadog/Trademarks.yml index da72ed2..ea8f2d0 100644 --- a/styles/Datadog/Trademarks.yml +++ b/styles/Datadog/Trademarks.yml @@ -13,7 +13,7 @@ nonword: true # Logging without Limits\* # Logging without Limits™ tokens: - - '(? Date: Wed, 31 Dec 2025 12:03:22 -0700 Subject: [PATCH 6/8] Remove duplicates, adjust some syntax --- styles/Datadog/aws.yml | 2 +- styles/Datadog/words_case_insensitive.yml | 11 +++---- styles/Datadog/words_case_sensitive.yml | 38 +++++++++++------------ 3 files changed, 25 insertions(+), 26 deletions(-) diff --git a/styles/Datadog/aws.yml b/styles/Datadog/aws.yml index 2108fcd..9149bfb 100644 --- a/styles/Datadog/aws.yml +++ b/styles/Datadog/aws.yml @@ -14,7 +14,7 @@ swap: AWS AppStream: Amazon AppStream Amazon AppSync: AWS AppSync AWS Athena: Amazon Athena - (Amazon|AWS) (Auto Scaling|Autoscaling|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 diff --git a/styles/Datadog/words_case_insensitive.yml b/styles/Datadog/words_case_insensitive.yml index ca5872a..b636770 100644 --- a/styles/Datadog/words_case_insensitive.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -15,14 +15,12 @@ swap: 'auto(?:\s|-)complete': autocomplete 'auto(?:\s|-)completion': autocompletion 'auto(?:\s|-)scale': autoscale - '(? Date: Wed, 31 Dec 2025 12:05:56 -0700 Subject: [PATCH 7/8] Remove duplicates --- styles/Datadog/words_case_insensitive.yml | 4 ---- styles/Datadog/words_case_sensitive.yml | 1 - 2 files changed, 5 deletions(-) diff --git a/styles/Datadog/words_case_insensitive.yml b/styles/Datadog/words_case_insensitive.yml index b636770..fcacdc9 100644 --- a/styles/Datadog/words_case_insensitive.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -27,10 +27,6 @@ swap: 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 diff --git a/styles/Datadog/words_case_sensitive.yml b/styles/Datadog/words_case_sensitive.yml index 1fefcd3..d838bdd 100644 --- a/styles/Datadog/words_case_sensitive.yml +++ b/styles/Datadog/words_case_sensitive.yml @@ -31,7 +31,6 @@ swap: 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 - memcached: Memcached Multistep API Test: multistep API test Once: After Performance Schema: performance schema From 844be9b5b9b26285f7411d0a3110bf84a9e013c7 Mon Sep 17 00:00:00 2001 From: Janine Chan <64388808+janine-c@users.noreply.github.com> Date: Wed, 31 Dec 2025 13:54:56 -0700 Subject: [PATCH 8/8] Efficiency! --- styles/Datadog/words_case_insensitive.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Datadog/words_case_insensitive.yml b/styles/Datadog/words_case_insensitive.yml index fcacdc9..1f48819 100644 --- a/styles/Datadog/words_case_insensitive.yml +++ b/styles/Datadog/words_case_insensitive.yml @@ -106,7 +106,7 @@ swap: multiline: multi-line multitier: multi-tier Note that: "**Note**:" - (?:obvious|obviously): '' + 'obvious(ly)?': '' off(?:\s|-)line: offline off(?:\s|-)board: offboard on(?:\s|-)board: onboard