Add vale (#183)

* add styles and cofig for vale for local checks and CI checks

* add docs as base dir

* fix parameter name

* make an edit to test

Author: rosieyohannan

.circleci/config.yml

@@ -7,6 +7,7 @@ parameters:
 
 orbs:
   aws-cli: circleci/[email protected]
+  vale: circleci/[email protected]
 
 executors:
   node_executor:
@@ -243,6 +244,14 @@ jobs:
 
 
 workflows:
+
+  lint:
+    unless:
+      equal: [ main, << pipeline.git.branch >> ]
+    jobs:
+      - vale/lint:
+          reference_branch: main
+          base_dir: docs
   build_validate_and_deploy:
     when:
       equal: ["", << pipeline.parameters.cleanup_preview_branch >>]

.gitignore

@@ -7,4 +7,5 @@ ui/node_modules/
 ui/public/
 ui/**/.DS_Store
 extensions/.temp
-.env
+.env
+.vscode/

.vale.ini

@@ -0,0 +1,21 @@
+StylesPath = styles
+
+Vocab = Docs
+
+MinAlertLevel = suggestion
+
+Packages = Readability
+
+[asciidoctor]
+# attribute = value
+#
+# where 'YES' enables and 'NO' disables.
+
+# enable
+experimental = YES
+
+# assign a specific value
+attribute-missing = drop
+
+[*.adoc]
+BasedOnStyles = circleci-docs, Vale, Readability, Openly

docs/guides/modules/about-circleci/pages/about-circleci.adoc

@@ -15,7 +15,7 @@ image::guides:ROOT:circleci-system-diagram.png[CircleCI process diagram]
 [#what-is-ci-cd]
 == What is CI/CD?
 
-*Continuous integration (CI)* is a practice that integrates code into a chosen branch of a shared repository, early and often. Instead of building out features in isolation and integrating them at the end of a development cycle, code is integrated with the shared repository by developers multiple times throughout the day by committing daily to a shared mainline. Every commit triggers automated tests and builds. If these fail, they can be repaired quickly.
+*Continuous integration (CI)* is a practice that integrates code into a chosen branch of a shared repository, early and often. Instead of building out features in isolation and integrating them at the end of a development cycle, code is integrated with the shared repository multiple times throughout the day. Every commit to a shared mainline triggers automated tests and builds. If these fail, they can be repaired quickly.
 
 *Continuous delivery (CD)* is a practice that produces reliable releases to a chosen development environment, like a staging or production branch.
 

styles/Openly/A11Y.yml

@@ -0,0 +1,9 @@
+---
+extends: substitution
+message: Consider using '%s' instead of '%s'
+ignorecase: true
+level: error
+action:
+  name: replace
+swap:
+  (?:^click|press): "'select'"

styles/Openly/Anthropomorphism.yml

@@ -0,0 +1,23 @@
+---
+extends: existence
+ignorecase: true
+level: warning
+message: "Don't attribute human qualities to software or hardware."
+raw:
+  - \b(?:PC|computer|object|machine|software|hardware|data|database|engine|message|command|interface)\b\s*
+tokens:
+  - sees
+  - tells
+  - thinks
+  - wants
+  - cares
+  - realizes
+  - assumes
+  - knows
+  - remembers
+  - decides
+  - knows
+  - refuses
+  - demands
+  - understands
+  - behaves

styles/Openly/But.yml

@@ -0,0 +1,12 @@
+---
+extends: existence
+message: "Do not start a paragraph with a 'but'."
+level: error
+scope: paragraph
+action:
+  name: remove
+  params:
+    - remove
+    - '.?!'
+tokens:
+  - ^But

styles/Openly/Clarity.yml

@@ -0,0 +1,8 @@
+---
+extends: substitution
+message: Consider using '%s' instead of '%s'
+level: warning
+ignorecase: false
+# swap maps tokens in form of bad: good
+swap:
+  help: assist

styles/Openly/E-Prime.yml

@@ -0,0 +1,27 @@
+---
+extends: existence
+message: 'Avoid using "%s"'
+ignorecase: true
+level: suggestion
+tokens:
+  - am
+  - aren't
+  - being
+  - he's
+  - here's
+  - here's
+  - how's
+  - i'm
+  - isn't
+  - she's
+  - that's
+  - there's
+  - they're
+  - wasn't
+  - we're
+  - weren't
+  - what's
+  - where's
+  - who's
+  - you're
+  - foobar

styles/Openly/FutureTense.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "Possible future tense."
+ignorecase: true
+level: warning
+tokens:
+  - will
+  - '[\w][ll]'
+  - we are going
+  - would-be
+  - would be