From 270538faa2f9b4ad4e6e0694bcb75a131666ab7d Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Mon, 15 Sep 2025 14:15:07 -0700 Subject: [PATCH 1/5] add new abbreviations and separate from latin --- styles/Datadog/abbreviations.yml | 37 ++++++++++++++++++++++++--- styles/Datadog/latinabbreviations.yml | 11 ++++++++ 2 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 styles/Datadog/latinabbreviations.yml diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index bcd2163..fbf1e61 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -1,5 +1,5 @@ extends: substitution -message: "Use '%s' instead of abbreviations like '%s'." +message: "Use abbreviations for common terms: '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" ignorecase: true level: warning @@ -7,5 +7,36 @@ nonword: true action: name: replace swap: - '\b(?:eg|e\.g\.|eg\.)[\s,]': for example - '\b(?:ie|i\.e\.|ie\.)[\s,]': that is + # full term: abbreviation + '\bArtificial Intelligence\b': AI + '\bApplication Programming Interface\b': API + '\b(?:Continuous Integration\s*/\s*Continuous Delivery|Continuous Integration\s*/\s*Continuous Deployment|Continuous Integration\s+and\s+Continuous\s+Delivery/Deployment)\b': CI/CD + '\bCentral Processing Unit\b': CPU + '\bDistributed Denial of Service\b': DDoS + '\bDevelopment Operations\b': DevOps + '\bDomain Name System\b': DNS + '\bFile Transfer Protocol\b': FTP + '\bGraphics Processing Unit\b': GPU + '\bHypertext Transfer Protocol\b': HTTP + '\bHypertext Transfer Protocol Secure\b': HTTPS + '\bInput/Output\b': I/O + '\bInput/Output Operations Per Second\b': IOPS + '\bInternet of Things\b': IoT + '\bInternet Protocol\b': IP + '\bJavaScript Object Notation\b': JSON + '\bMachine Learning\b': ML + '\bPortable Document Format\b': PDF + '\bRandom Access Memory\b': RAM + '\bSecurity Assertion Markup Language\b': SAML + '\bSoftware Development Kit\b': SDK + '\bSecurity Information and Event Management\b': SIEM + '\bStructured Query Language\b': SQL + '\bSecure Shell\b': SSH + '\bSecure Sockets Layer\b': SSL + '\bTransport Layer Security\b': TLS + '\bUser Interface\b': UI + '\bUniform Resource Locator\b': URL + '\bVirtual Machine\b': VM + '\bVirtual Private Network\b': VPN + '\bExtensible Markup Language\b': XML + diff --git a/styles/Datadog/latinabbreviations.yml b/styles/Datadog/latinabbreviations.yml new file mode 100644 index 0000000..bcd2163 --- /dev/null +++ b/styles/Datadog/latinabbreviations.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of abbreviations like '%s'." +link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" +ignorecase: true +level: warning +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.|eg\.)[\s,]': for example + '\b(?:ie|i\.e\.|ie\.)[\s,]': that is From ef9336942c4902f1ea1b197555312872ae108681 Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Mon, 15 Sep 2025 14:16:22 -0700 Subject: [PATCH 2/5] industry --- styles/Datadog/abbreviations.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index fbf1e61..3d50abb 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -1,5 +1,5 @@ extends: substitution -message: "Use abbreviations for common terms: '%s' instead of '%s'." +message: "Use abbreviations for common industry terms: '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" ignorecase: true level: warning From 5117003eea455bf7111e25d8676ec5a65f033d9d Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Mon, 15 Sep 2025 14:31:39 -0700 Subject: [PATCH 3/5] add upon first mention --- styles/Datadog/abbreviations.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index 3d50abb..13f4411 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -1,5 +1,5 @@ extends: substitution -message: "Use abbreviations for common industry terms: '%s' instead of '%s'." +message: "Use abbreviations for common industry terms upon first mention: '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" ignorecase: true level: warning From e41ac624fdc747d4b03d8c77620327cbfb342cec Mon Sep 17 00:00:00 2001 From: Rosa Trieu <107086888+rtrieu@users.noreply.github.com> Date: Tue, 16 Sep 2025 08:19:04 -0700 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com> --- styles/Datadog/abbreviations.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index 13f4411..3d50abb 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -1,5 +1,5 @@ extends: substitution -message: "Use abbreviations for common industry terms upon first mention: '%s' instead of '%s'." +message: "Use abbreviations for common industry terms: '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" ignorecase: true level: warning From 6557deb64998372c30f32ffdb5e49ff816a717d2 Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Wed, 17 Sep 2025 11:10:32 -0700 Subject: [PATCH 5/5] add description as note to datadog styles --- styles/Datadog/Trademarks.yml | 1 + styles/Datadog/abbreviations.yml | 1 + .../Datadog/{latinabbreviations.yml => abbreviations_latin.yml} | 1 + styles/Datadog/americanspelling.yml | 1 + styles/Datadog/autodiscovery.yml | 1 + styles/Datadog/aws.yml | 1 + styles/Datadog/dashes.yml | 1 + styles/Datadog/endash.yml | 1 + styles/Datadog/gender.yml | 1 + styles/Datadog/headings.yml | 1 + styles/Datadog/inclusive.yml | 1 + styles/Datadog/links.yml | 1 + styles/Datadog/merge_conflict.yml | 1 + styles/Datadog/oxfordcomma.yml | 1 + styles/Datadog/pronouns.yml | 1 + styles/Datadog/quotes.yml | 1 + styles/Datadog/sentencelength.yml | 1 + styles/Datadog/spaces.yml | 1 + styles/Datadog/tense.yml | 1 + styles/Datadog/time.yml | 1 + 20 files changed, 20 insertions(+) rename styles/Datadog/{latinabbreviations.yml => abbreviations_latin.yml} (80%) diff --git a/styles/Datadog/Trademarks.yml b/styles/Datadog/Trademarks.yml index da72ed2..ed27290 100644 --- a/styles/Datadog/Trademarks.yml +++ b/styles/Datadog/Trademarks.yml @@ -1,3 +1,4 @@ +# This file is used to lint trademarks. extends: existence message: Missing ™ on phrase '%s' link: https://www.datadoghq.com diff --git a/styles/Datadog/abbreviations.yml b/styles/Datadog/abbreviations.yml index 3d50abb..7cebc5d 100644 --- a/styles/Datadog/abbreviations.yml +++ b/styles/Datadog/abbreviations.yml @@ -1,3 +1,4 @@ +# This file is used to lint abbreviations that are common across all languages. extends: substitution message: "Use abbreviations for common industry terms: '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" diff --git a/styles/Datadog/latinabbreviations.yml b/styles/Datadog/abbreviations_latin.yml similarity index 80% rename from styles/Datadog/latinabbreviations.yml rename to styles/Datadog/abbreviations_latin.yml index bcd2163..0c3cac6 100644 --- a/styles/Datadog/latinabbreviations.yml +++ b/styles/Datadog/abbreviations_latin.yml @@ -1,3 +1,4 @@ +# This file is used to lint abbreviations that are specific to Latin languages. extends: substitution message: "Use '%s' instead of abbreviations like '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#abbreviations" diff --git a/styles/Datadog/americanspelling.yml b/styles/Datadog/americanspelling.yml index 415b8e6..42c394a 100644 --- a/styles/Datadog/americanspelling.yml +++ b/styles/Datadog/americanspelling.yml @@ -1,3 +1,4 @@ +# This file is used to lint American spelling instead of British spelling. extends: existence message: "In general, use American spelling instead of '%s'." link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md' diff --git a/styles/Datadog/autodiscovery.yml b/styles/Datadog/autodiscovery.yml index 7a117c1..0e12af9 100644 --- a/styles/Datadog/autodiscovery.yml +++ b/styles/Datadog/autodiscovery.yml @@ -1,3 +1,4 @@ +# This file is used to lint autodiscovery instead of automatic discovery. 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' diff --git a/styles/Datadog/aws.yml b/styles/Datadog/aws.yml index 58e1b3b..f00b042 100644 --- a/styles/Datadog/aws.yml +++ b/styles/Datadog/aws.yml @@ -1,3 +1,4 @@ +# This file is used to lint AWS services. extends: substitution message: "Use the proper trademark '%s' instead of '%s'." link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md' diff --git a/styles/Datadog/dashes.yml b/styles/Datadog/dashes.yml index 0403654..247da35 100644 --- a/styles/Datadog/dashes.yml +++ b/styles/Datadog/dashes.yml @@ -1,3 +1,4 @@ +# This file is used to lint dashes. extends: existence message: "Don't put a space before or after a dash." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#dashes" diff --git a/styles/Datadog/endash.yml b/styles/Datadog/endash.yml index 6855de8..6ed857a 100644 --- a/styles/Datadog/endash.yml +++ b/styles/Datadog/endash.yml @@ -1,3 +1,4 @@ +# This file is used to lint en dashes. extends: existence message: "Avoid en dashes ('–'). For hyphenated words, use a hyphen ('-').\nFor parenthesis, use an em dash ('—')." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#dashes" diff --git a/styles/Datadog/gender.yml b/styles/Datadog/gender.yml index b2b19b7..930234e 100644 --- a/styles/Datadog/gender.yml +++ b/styles/Datadog/gender.yml @@ -1,3 +1,4 @@ +# This file is used to lint gender-neutral pronouns. extends: existence message: "Use a gender-neutral pronoun instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#gender" diff --git a/styles/Datadog/headings.yml b/styles/Datadog/headings.yml index 3979762..0f0ee11 100644 --- a/styles/Datadog/headings.yml +++ b/styles/Datadog/headings.yml @@ -1,3 +1,4 @@ +# This file is used to lint headings that do not capitalize product and feature names correctly. extends: capitalization message: "'%s' should use sentence-style capitalization." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#headers" diff --git a/styles/Datadog/inclusive.yml b/styles/Datadog/inclusive.yml index bc1a9df..f7444e5 100644 --- a/styles/Datadog/inclusive.yml +++ b/styles/Datadog/inclusive.yml @@ -1,3 +1,4 @@ +# This file is used to lint inclusive language. extends: substitution message: "Use '%s' instead of '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#inclusive-language" diff --git a/styles/Datadog/links.yml b/styles/Datadog/links.yml index dbe815a..e3c0cc1 100644 --- a/styles/Datadog/links.yml +++ b/styles/Datadog/links.yml @@ -1,3 +1,4 @@ +# This file is used to lint vague text in links. extends: substitution message: "Avoid vague text in links like '%s' unless you can pair it with more descriptive text." link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#links' diff --git a/styles/Datadog/merge_conflict.yml b/styles/Datadog/merge_conflict.yml index 62604cd..e1de11a 100644 --- a/styles/Datadog/merge_conflict.yml +++ b/styles/Datadog/merge_conflict.yml @@ -1,3 +1,4 @@ +# This file is used to lint merge conflicts. extends: existence message: "It looks like you have a merge conflict! Fix the conflict and try again." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#dashes" diff --git a/styles/Datadog/oxfordcomma.yml b/styles/Datadog/oxfordcomma.yml index 64e4e2f..c946234 100644 --- a/styles/Datadog/oxfordcomma.yml +++ b/styles/Datadog/oxfordcomma.yml @@ -1,3 +1,4 @@ +# This file is used to lint the Oxford comma. extends: existence message: "Use the Oxford comma in '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#commas" diff --git a/styles/Datadog/pronouns.yml b/styles/Datadog/pronouns.yml index 78c3f44..e7b0006 100644 --- a/styles/Datadog/pronouns.yml +++ b/styles/Datadog/pronouns.yml @@ -1,3 +1,4 @@ +# This file is used to lint first-person pronouns. extends: existence message: "Avoid first-person pronouns such as '%s'." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#pronouns" diff --git a/styles/Datadog/quotes.yml b/styles/Datadog/quotes.yml index 2c4bb94..dfc71c7 100644 --- a/styles/Datadog/quotes.yml +++ b/styles/Datadog/quotes.yml @@ -1,3 +1,4 @@ +# This file is used to lint smart quotes. extends: existence message: Use straight quotes instead of smart quotes. level: error diff --git a/styles/Datadog/sentencelength.yml b/styles/Datadog/sentencelength.yml index dd590a9..e78bc55 100644 --- a/styles/Datadog/sentencelength.yml +++ b/styles/Datadog/sentencelength.yml @@ -1,3 +1,4 @@ +# This file is used to lint sentence length. extends: occurrence message: "Try to keep your sentence length to 25 words or fewer." level: suggestion diff --git a/styles/Datadog/spaces.yml b/styles/Datadog/spaces.yml index 6a1fa80..465b182 100644 --- a/styles/Datadog/spaces.yml +++ b/styles/Datadog/spaces.yml @@ -1,3 +1,4 @@ +# This file is used to lint spaces. extends: existence message: "Use only one space between words and sentences (not two)." link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#spaces' diff --git a/styles/Datadog/tense.yml b/styles/Datadog/tense.yml index 84862a9..51de197 100644 --- a/styles/Datadog/tense.yml +++ b/styles/Datadog/tense.yml @@ -1,3 +1,4 @@ +# This file is used to lint temporal words. extends: existence message: "Avoid temporal words like '%s'." link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#tense' diff --git a/styles/Datadog/time.yml b/styles/Datadog/time.yml index 92091af..4a13828 100644 --- a/styles/Datadog/time.yml +++ b/styles/Datadog/time.yml @@ -1,3 +1,4 @@ +# This file is used to lint time formatting. 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"