From 2a240027cdedbe3425a2cc258cad90e0cc1cf0fc Mon Sep 17 00:00:00 2001 From: cecilia saixue watt Date: Mon, 4 Dec 2023 16:10:06 -0800 Subject: [PATCH 1/5] adding gobwords and other cleanup --- styles/Datadog/apostrophe.yml | 7 ++ styles/Datadog/autodiscovery.yml | 11 ++ styles/Datadog/words.yml | 182 ++++++++++++++++++++++--------- 3 files changed, 151 insertions(+), 49 deletions(-) create mode 100644 styles/Datadog/apostrophe.yml create mode 100644 styles/Datadog/autodiscovery.yml diff --git a/styles/Datadog/apostrophe.yml b/styles/Datadog/apostrophe.yml new file mode 100644 index 0000000..50977db --- /dev/null +++ b/styles/Datadog/apostrophe.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Possessive nouns receive an `'s`, even if they are proper nouns that end in `s`." +link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#apostrophes' +ignorecase: true +level: warning +tokens: + - "[a-zA-Z]*' " diff --git a/styles/Datadog/autodiscovery.yml b/styles/Datadog/autodiscovery.yml new file mode 100644 index 0000000..e786c48 --- /dev/null +++ b/styles/Datadog/autodiscovery.yml @@ -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 diff --git a/styles/Datadog/words.yml b/styles/Datadog/words.yml index aba42ac..1375b75 100644 --- a/styles/Datadog/words.yml +++ b/styles/Datadog/words.yml @@ -7,52 +7,136 @@ 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 + catalogue: catalog + catalogues: catalogs + command line interface: command-line interface + Create a new: Create a|Create an + culprit: cause + '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 + (?:Dev/?ops|dev/?ops|Dev/Ops): DevOps|DevSecOps + '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 + 'end(?:\s|-)point': endpoint + 'end(?:\s|-)points': endpoints + 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 + From 6fa17fd19e1477b78711dbfe16f94a3997b80992 Mon Sep 17 00:00:00 2001 From: cecilia saixue watt Date: Wed, 6 Dec 2023 13:02:29 -0800 Subject: [PATCH 2/5] more --- styles/Datadog/abbreviations.yml | 1 - styles/Datadog/americanspelling.yml | 94 ++++++++++++++++------------- styles/Datadog/apostrophe.yml | 7 --- 3 files changed, 52 insertions(+), 50 deletions(-) delete mode 100644 styles/Datadog/apostrophe.yml diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index 0613548..bcd2163 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -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 diff --git a/styles/Datadog/americanspelling.yml b/styles/Datadog/americanspelling.yml index 296ff3d..415b8e6 100644 --- a/styles/Datadog/americanspelling.yml +++ b/styles/Datadog/americanspelling.yml @@ -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 \ No newline at end of file diff --git a/styles/Datadog/apostrophe.yml b/styles/Datadog/apostrophe.yml deleted file mode 100644 index 50977db..0000000 --- a/styles/Datadog/apostrophe.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Possessive nouns receive an `'s`, even if they are proper nouns that end in `s`." -link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#apostrophes' -ignorecase: true -level: warning -tokens: - - "[a-zA-Z]*' " From 79485964708a59b1fab7ffee88769dabe57d7603 Mon Sep 17 00:00:00 2001 From: cecilia saixue watt Date: Fri, 8 Dec 2023 13:36:39 -0800 Subject: [PATCH 3/5] pulling in changes from pr53 --- styles/Datadog/time.yml | 9 +++++++++ styles/Datadog/words.yml | 8 ++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 styles/Datadog/time.yml diff --git a/styles/Datadog/time.yml b/styles/Datadog/time.yml new file mode 100644 index 0000000..7537412 --- /dev/null +++ b/styles/Datadog/time.yml @@ -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: error +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) diff --git a/styles/Datadog/words.yml b/styles/Datadog/words.yml index 1375b75..3f99357 100644 --- a/styles/Datadog/words.yml +++ b/styles/Datadog/words.yml @@ -19,11 +19,11 @@ swap: bear in mind: keep in mind boolean: Boolean booleans: Booleans - catalogue: catalog - catalogues: catalogs + 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 @@ -34,9 +34,12 @@ swap: 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 @@ -45,6 +48,7 @@ swap: 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 From 6591641d859acc64d7a30f34f9dfcc84b3b0c8e5 Mon Sep 17 00:00:00 2001 From: cecilia saixue watt Date: Wed, 24 Jan 2024 15:30:22 -0800 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Heston Hoffman --- styles/Datadog/autodiscovery.yml | 2 +- styles/Datadog/time.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/styles/Datadog/autodiscovery.yml b/styles/Datadog/autodiscovery.yml index e786c48..972517e 100644 --- a/styles/Datadog/autodiscovery.yml +++ b/styles/Datadog/autodiscovery.yml @@ -1,5 +1,5 @@ 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'." +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 diff --git a/styles/Datadog/time.yml b/styles/Datadog/time.yml index 7537412..c678ced 100644 --- a/styles/Datadog/time.yml +++ b/styles/Datadog/time.yml @@ -5,5 +5,5 @@ level: error 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)(a\.m[^\.]|p\.m[^\.]) - (1[012]|[1-9]):[0-5][0-9][ ]?(?i)(am|pm) From cc3590859100643aece7f803add243eeba734155 Mon Sep 17 00:00:00 2001 From: cecilia saixue watt Date: Wed, 24 Jan 2024 15:30:45 -0800 Subject: [PATCH 5/5] Update time.yml --- styles/Datadog/time.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Datadog/time.yml b/styles/Datadog/time.yml index c678ced..92091af 100644 --- a/styles/Datadog/time.yml +++ b/styles/Datadog/time.yml @@ -1,7 +1,7 @@ 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: error +level: warning nonword: true tokens: - (1[012]|[1-9]):[0-5][0-9] (A\.M\.|P\.M\.)