Merge pull request #7 from sfadriaan/vale-setup

Vale setup

Author: sfadriaan

.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

.vale.ini

@@ -0,0 +1,5 @@
+StylesPath = styles
+MinAlertLevel = suggestion
+
+[*.{md,rst}]
+BasedOnStyles = Google, Custom

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "makefile.configureOnOpen": false
+}

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

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

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. 

how-to/omnistudio/omnistudio-getting-started.rst

@@ -1,4 +1,4 @@
-Getting Started
+Getting started
 ===============
 
 .. toctree::

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.

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

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]\.'