sfadriaan · sfadriaan · Aug 16, 2024 · Aug 16, 2024 · Aug 16, 2024 · Aug 16, 2024
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,24 @@
+name: lint
+
+on: 
+  pull_request:
+
+jobs:
+  vale:
+    name: Style checker
+    runs-on: ubuntu-22.04
+    defaults:
+        run:
+            shell: bash
+            working-directory: .
+    steps:
+        - name: Checkout repo to runner
+          uses: actions/checkout@v4
+        - name: Run Vale tests
+          uses: errata-ai/vale-action@reviewdog
+          with:
+            version: 3.7.0
+            files: '["how-to", "tutorials", "reference", "explanation"]'
+            fail_on_error: true
+            reporter: github-pr-review
+            filter_mode: nofilter
diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1,5 @@
+StylesPath = styles
+MinAlertLevel = suggestion
+
+[*.{md,rst}]
+BasedOnStyles = Google, Custom
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "makefile.configureOnOpen": false
+}
diff --git a/how-to/index.rst b/how-to/index.rst
@@ -1,9 +1,9 @@
 :hide-toc:
 
-How-To Guides
+How-to guides
 =============
 
-The How-To section is broken up into different subsections to help you better navigate to where you want to be.
+The How-To section consists of different subsections to help you better navigate to where you want to be.
 
 .. toctree::
    :maxdepth: 1

diff --git a/how-to/omnistudio/omnistudio-check-package-version.rst b/how-to/omnistudio/omnistudio-check-package-version.rst
@@ -1,21 +1,21 @@
-Check OmniStudio Package Version
+Check OmniStudio package version
 ================================
 
-Updates to the OmniStudio Managed Package are released with the Salesforce release cycle i.e. Spring, Summer, and Winter.
-If OmniStudio is installed in your production environment, updates should happen automatically.
+Salesforce releases updates to the OmniStudio Managed Package during every release cycle i.e. Spring, Summer, and Winter.
+Updates to the Omnistudio Managed Package should happen automatically in your production org.
 
-In the event that you have a trail org that has an outdated version (or your production org has not updated automatically), you can manually update the managed package.
+In the event that you have a trail org that has an outdated version, or your production org hasn't updated automatically, you can manually update the managed package.
 
 1. Check latest version by visiting the `OmniStudio Release page <https://help.salesforce.com/s/articleView?id=000394906&type=1>`_
-2. Check which version is installed in your org (production org or trail org)
+2. Check which version is in your org:
     a. Navigate to Setup
     b. Search ``Installed Packages``
     c. Search for Package Name ``Omnistudio``
     d. Check version number
 
     .. figure:: /images/omnistudio-outdated-package-version.png
 
-    e. If the version is outdated, follow the instructions in the `OmniStudio Release page <https://help.salesforce.com/s/articleView?id=000394906&type=1>`_ to install the latest version.
+    e. For outdated versions, follow the instructions in the `OmniStudio Release page <https://help.salesforce.com/s/articleView?id=000394906&type=1>`_ to install the latest version.
     f. After the updates/installation has completed, verify that the Installed Package version is correct.
 
     .. figure:: /images/omnistudio-latest-package-version.png
diff --git a/how-to/omnistudio/omnistudio-get-dev-org.rst b/how-to/omnistudio/omnistudio-get-dev-org.rst
@@ -1,22 +1,24 @@
-Getting an OmniStudio Enabled Org
+Getting an OmniStudio enabled org
 =================================
 
-It is important to ensure you have an up to date Omnistudio environment to develop in.
-Depending on your situation you will:
+It's important to ensure you have an up to date Omnistudio environment to develop in.
+Depending on your situation you:
 
-* have access to a sandbox that is created from a production org that has Omnistudio installed,
+* have access to a sandbox that's created from a production org that has Omnistudio installed,
 * have the ability to create a scratch org that has Omnistudio enabled,
 * not have access to a production org that has Omnistudio installed.
 
 There are multiple options where you can sign up for a free trial org that has Omnistudio installed:
 
-1. `Financial Services Cloud <https://developer.salesforce.com/free-trials/comparison/financial-services-cloud>`_ (*recommended*)
+1. `Financial Services Cloud <https://developer.salesforce.com/free-trials/comparison/financial-services-cloud>`_ *recommended*
     * Always have an up to date Omnistudio installed at the time of sign up.
-    * Two options are available (Learning org vs Base org)
+    * Two options are available
+        * Base org
+        * Learning org
 2. `Industries Training Playground <https://vlocitytrial-prod.herokuapp.com/?templateid=SFI_IPQ>`_
     * Has Vlocity Omnistudio installed.
 3. `Approval Process for Public Sector Solutions Org <https://trailhead.salesforce.com/promo/orgs/approval-process-for-public-sector-solutions>`_
     * Outdated Omnistudio version installed
 
-These orgs are valid for 30 days (most of the times).
-You will have to sign up for another org when your trial period ends to continue your development. 
+These orgs are valid for 30 days.
+Sign up for another org when your trial period ends to continue your development. 
diff --git a/how-to/omnistudio/omnistudio-getting-started.rst b/how-to/omnistudio/omnistudio-getting-started.rst
@@ -1,4 +1,4 @@
-Getting Started
+Getting started
 ===============
 
 .. toctree::

diff --git a/how-to/omnistudio/omnistudio-index.rst b/how-to/omnistudio/omnistudio-index.rst
@@ -1,7 +1,7 @@
 OmniStudio
 ==========
 
-Getting Started
+Getting started
 ---------------
 
 Get your development environment set up with the latest version of OmniStudio.

diff --git a/styles/Custom/Spelling.yml b/styles/Custom/Spelling.yml
@@ -0,0 +1,6 @@
+extends: spelling
+message: "Did you really mean '%s'?"
+level: error
+ignore:
+  # Located at StylesPath/ignore.txt
+  - ignore.txt
diff --git a/styles/Google/AMPM.yml b/styles/Google/AMPM.yml
@@ -0,0 +1,9 @@
+extends: existence
+message: "Use 'AM' or 'PM' (preceded by a space)."
+link: 'https://developers.google.com/style/word-list'
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}[AP]M'
+  - '\d{1,2} ?[ap]m'
+  - '\d{1,2} ?[aApP]\.[mM]\.'
diff --git a/styles/Google/Acronyms.yml b/styles/Google/Acronyms.yml
@@ -0,0 +1,64 @@
+extends: conditional
+message: "Spell out '%s', if it's unfamiliar to the audience."
+link: 'https://developers.google.com/style/abbreviations'
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - XML
+  - XSS
+  - YAML
+  - ZIP
diff --git a/styles/Google/Colons.yml b/styles/Google/Colons.yml
@@ -0,0 +1,8 @@
+extends: existence
+message: "'%s' should be in lowercase."
+link: 'https://developers.google.com/style/colons'
+nonword: true
+level: warning
+scope: sentence
+tokens:
+  - ':\s[A-Z]'
diff --git a/styles/Google/Contractions.yml b/styles/Google/Contractions.yml
@@ -0,0 +1,30 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: 'https://developers.google.com/style/contractions'
+level: suggestion
+ignorecase: true
+action:
+  name: replace
+swap:
+  are not: aren't
+  cannot: can't
+  could not: couldn't
+  did not: didn't
+  do not: don't
+  does not: doesn't
+  has not: hasn't
+  have not: haven't
+  how is: how's
+  is not: isn't
+  it is: it's
+  should not: shouldn't
+  that is: that's
+  they are: they're
+  was not: wasn't
+  we are: we're
+  we have: we've
+  were not: weren't
+  what is: what's
+  when is: when's
+  where is: where's
+  will not: won't
diff --git a/styles/Google/DateFormat.yml b/styles/Google/DateFormat.yml
@@ -0,0 +1,9 @@
+extends: existence
+message: "Use 'July 31, 2016' format, not '%s'."
+link: 'https://developers.google.com/style/dates-times'
+ignorecase: true
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
+  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'
diff --git a/styles/Google/Ellipses.yml b/styles/Google/Ellipses.yml
@@ -0,0 +1,9 @@
+extends: existence
+message: "In general, don't use an ellipsis."
+link: 'https://developers.google.com/style/ellipses'
+nonword: true
+level: warning
+action:
+  name: remove
+tokens:
+  - '\.\.\.'
diff --git a/styles/Google/EmDash.yml b/styles/Google/EmDash.yml
@@ -0,0 +1,13 @@
+extends: existence
+message: "Don't put a space before or after a dash."
+link: "https://developers.google.com/style/dashes"
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - trim
+    - " "
+tokens:
+  - '\s[—–]\s'
+
diff --git a/styles/Google/Exclamation.yml b/styles/Google/Exclamation.yml
@@ -0,0 +1,12 @@
+extends: existence
+message: "Don't use exclamation points in text."
+link: "https://developers.google.com/style/exclamation-points"
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - trim_right
+    - "!"
+tokens:
+  - '\w+!(?:\s|$)'
diff --git a/styles/Google/FirstPerson.yml b/styles/Google/FirstPerson.yml
@@ -0,0 +1,13 @@
+extends: existence
+message: "Avoid first-person pronouns such as '%s'."
+link: 'https://developers.google.com/style/pronouns#personal-pronouns'
+ignorecase: true
+level: warning
+nonword: true
+tokens:
+  - (?:^|\s)I\s
+  - (?:^|\s)I,\s
+  - \bI'm\b
+  - \bme\b
+  - \bmy\b
+  - \bmine\b
diff --git a/styles/Google/Gender.yml b/styles/Google/Gender.yml
@@ -0,0 +1,9 @@
+extends: existence
+message: "Don't use '%s' as a gender-neutral pronoun."
+link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
+level: error
+ignorecase: true
+tokens:
+  - he/she
+  - s/he
+  - \(s\)he
diff --git a/styles/Google/GenderBias.yml b/styles/Google/GenderBias.yml
@@ -0,0 +1,43 @@
+extends: substitution
+message: "Consider using '%s' instead of '%s'."
+ignorecase: true
+link: "https://developers.google.com/style/inclusive-documentation"
+level: error
+action:
+  name: replace
+swap:
+  (?:alumna|alumnus): graduate
+  (?:alumnae|alumni): graduates
+  air(?:m[ae]n|wom[ae]n): pilot(s)
+  anchor(?:m[ae]n|wom[ae]n): anchor(s)
+  authoress: author
+  camera(?:m[ae]n|wom[ae]n): camera operator(s)
+  door(?:m[ae]|wom[ae]n): concierge(s)
+  draft(?:m[ae]n|wom[ae]n): drafter(s)
+  fire(?:m[ae]n|wom[ae]n): firefighter(s)
+  fisher(?:m[ae]n|wom[ae]n): fisher(s)
+  fresh(?:m[ae]n|wom[ae]n): first-year student(s)
+  garbage(?:m[ae]n|wom[ae]n): waste collector(s)
+  lady lawyer: lawyer
+  ladylike: courteous
+  mail(?:m[ae]n|wom[ae]n): mail carriers
+  man and wife: husband and wife
+  man enough: strong enough
+  mankind: human kind|humanity
+  manmade: manufactured
+  manpower: personnel
+  middle(?:m[ae]n|wom[ae]n): intermediary
+  news(?:m[ae]n|wom[ae]n): journalist(s)
+  ombuds(?:man|woman): ombuds
+  oneupmanship: upstaging
+  poetess: poet
+  police(?:m[ae]n|wom[ae]n): police officer(s)
+  repair(?:m[ae]n|wom[ae]n): technician(s)
+  sales(?:m[ae]n|wom[ae]n): salesperson or sales people
+  service(?:m[ae]n|wom[ae]n): soldier(s)
+  steward(?:ess)?: flight attendant
+  tribes(?:m[ae]n|wom[ae]n): tribe member(s)
+  waitress: waiter
+  woman doctor: doctor
+  woman scientist[s]?: scientist(s)
+  work(?:m[ae]n|wom[ae]n): worker(s)
diff --git a/styles/Google/HeadingPunctuation.yml b/styles/Google/HeadingPunctuation.yml
@@ -0,0 +1,13 @@
+extends: existence
+message: "Don't put a period at the end of a heading."
+link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
+nonword: true
+level: warning
+scope: heading
+action:
+  name: edit
+  params:
+    - trim_right
+    - "."
+tokens:
+  - '[a-z0-9][.]\s*$'