Skip to content

Commit

Permalink
Update WordList.yml (#30)
Browse files Browse the repository at this point in the history
* Update WordList.yml

Added Splunk Observability Cloud platform

* Update DontUse.yml

Removed line about definite articles for product names: - '(?:the|The) (?:Splunk IT Cloud|Splunk Security Cloud|Splunk Observability Cloud)'

* Create ProductTerms.yml

Added a new rule capturing a warning for using definite articles with product terms
  • Loading branch information
erica-splunk authored Jun 1, 2023
1 parent eb1c0c1 commit a721539
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
1 change: 0 additions & 1 deletion styles/Splunk/DontUse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ link: https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Usaged
ignorecase: true
level: error
tokens:
- '(?:the|The) (?:Splunk IT Cloud|Splunk Security Cloud|Splunk Observability Cloud)'
- a.k.a.
- aka
- and/or
Expand Down
7 changes: 7 additions & 0 deletions styles/Splunk/ProductTerms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Verify your use of '%s' with the Splunk product terminology guidelines. Use a definite article only if the product acts as an adjective."
link: 'https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Terminology'
level: warning
ignorecase: true
tokens:
- '(?:the|The) (?:Splunk IT Cloud|Splunk Security Cloud|Splunk Observability Cloud)'
1 change: 1 addition & 0 deletions styles/Splunk/WordList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ swap:
'SIT': Splunk IT Cloud
'SSC': Splunk Security Cloud
'SOC': Splunk Observability Cloud
'Splunk Observability Cloud platform': Splunk Observability Cloud
'(?:UNIX|Linux)': Use *nix if both Linux and UNIX are supported.
'(?:addon|add-On|Add-On|AddOn)': add-on|Add-on
'(?:addons|add-Ons|Add-Ons|AddOns)': add-ons|Add-ons
Expand Down

0 comments on commit a721539

Please sign in to comment.