Add abbreviations warnings

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

styles/Datadog/abbreviations.yml

@@ -1,11 +1,43 @@
+# This file is used to lint abbreviations that are common across all languages.
 extends: substitution
-message: "Use '%s' instead of abbreviations like '%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
 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
+

styles/Datadog/abbreviations_latin.yml

@@ -0,0 +1,12 @@
+# 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"
+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

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'

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'

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'

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"

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"

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"

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"

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"

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'

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"

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"

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"

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

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

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'

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'

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"