Add Vale to CircleCI for linting documentation

.circleci/config.yml

@@ -4,6 +4,8 @@ orbs:
   browser-tools: circleci/browser-tools@1.4.8
   ruby: circleci/ruby@2.1.4
   node: circleci/node@5.3.0
+  browser-tools: circleci/browser-tools@1.4.6
+  vale: circleci/vale@1.0.0
 executors:
   orangelight-executor:
     docker:
@@ -225,6 +227,8 @@ workflows:
       - test:
          requires:
           - build
+      - vale/lint
+          config: docs/.vale.ini
       - finish:
          requires:
            - test

README.md

@@ -154,6 +154,16 @@ It will tell you if you've passed the assertion(s) specified
 in `lighthouserc.js`.  It will also give you a URL where you
 can see the complete lighthouse results.
 
+#### Documentation linting with vale
+
+To run locally:
+```
+brew install vale
+cd docs
+vale sync
+vale .
+```
+
 #### Running CodeQL locally
 
 If you get a CodeQL warning on your branch, you may wish to run

docs/.vale.ini

@@ -0,0 +1,11 @@
+StylesPath = .vale
+
+MinAlertLevel = suggestion
+
+Packages = RedHat
+
+Vocab = Base
+
+[*]
+BasedOnStyles = Vale, RedHat
+

docs/.vale/config/vocabularies/Base/accept.txt

@@ -0,0 +1,12 @@
+Ctrl
+figgy
+Figgy
+iiif
+Marquand
+Mudd
+orangelight
+Orangelight
+postgres
+solr
+Solr
+tmux

docs/browse-lists.md

@@ -39,7 +39,7 @@ Fix:
 - Find which machine to use from section: `How to know which machine to use`. Currently the `call_numbers` task is deployed to run on `catalog-indexer3`.
 - SSH as `deploy` user to the machine used to produce the subjects lists
 
-- Run the first rake task to generate the CSV file from solr data:
+- Run the first rake task to generate the CSV file from Solr data:
 - `cd /opt/orangelight/current`
 - `OL_DB_PORT=5432 bundle exec rake browse:subjects`