ci: update vale

.github/workflows/vale.yml

@@ -1,4 +1,4 @@
-name: Linting
+name: Vale
 on:
   push:
     branches:
@@ -10,17 +10,14 @@ on:
       - "docs/**"
 
 jobs:
-  prose:
+  vale:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: Vale
-        uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084 # v2.0.1
+        uses: errata-ai/vale-action@3f7188c866bcb3259339a09f517d7c4a8838303c # reviewdog
         with:
           files: docs/docs
-        env:
-          # Required, set by GitHub actions automatically:
-          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          fail_on_error: true

.vale.ini

@@ -3,6 +3,7 @@ Vocab = edgeless
 
 [*.md]
 BasedOnStyles = Vale, Microsoft, Google
+Vale.Terms = NO
 
 # decrease to suggestion
 Microsoft.Foreign = suggestion  # conflicts with Microsoft.Contractions

docs/docs/getting-started/quickstart.md

@@ -81,7 +81,7 @@ It can also be used as a root of trust for [authenticating your confidential app
 :::info
 
 By default the certificate is saved to `$XDG_CONFIG_HOME/marblerun/coordinator-cert.pem`,
-or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` is not set.
+or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` isn't set.
 Subsequent CLI commands will try loading the certificate from that location.
 Use the `--coordinator-cert` flag to choose your own location to save or load the certificate.
 

docs/docs/workflows/set-manifest.md

@@ -15,7 +15,7 @@ This ensures you are always talking to the same instance the manifest was upload
 :::info
 
 By default the certificate is saved to `$XDG_CONFIG_HOME/marblerun/coordinator-cert.pem`,
-or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` is not set.
+or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` isn't set.
 Subsequent CLI commands will try loading the certificate from that location.
 Use the `--coordinator-cert` flag to choose your own location to save or load the certificate.
 

docs/docs/workflows/verification.md

@@ -6,7 +6,7 @@ Specifically, the Coordinator exposes the `/quote` endpoint that returns a quote
 
 ## Verifying the quote and the manifest using the CLI
 
-The `marblerun manifest verify` command uses the two endpoints described above. It first verifies the Coordinator's quote according to a given policy and then checks that the expected `manifest.json` is in effect. 
+The `marblerun manifest verify` command uses the two endpoints described above. It first verifies the Coordinator's quote according to a given policy and then checks that the expected `manifest.json` is in effect.
 
 :::info
 
@@ -27,7 +27,7 @@ If successful, the certificates of the root CA and the intermediate CA are saved
 :::info
 
 By default, the command will save the Coordinators certificate chain to `$XDG_CONFIG_HOME/marblerun/coordinator-cert.pem`,
-or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` is not set.
+or `$HOME/.config/marblerun/coordinator-cert.pem` if `$XDG_CONFIG_HOME` isn't set.
 Subsequent CLI commands will try loading the certificate from that location.
 Use the `--coordinator-cert` flag to choose your own location to save or load the certificate.
 

docs/styles/Google/Spelling.yml

@@ -5,4 +5,6 @@ ignorecase: true
 level: warning
 tokens:
   - '(?:\w+)nised?'
-  - '(?:\w+)logue'
+  - 'colour'
+  - 'labour'
+  - 'centre'

docs/styles/Google/Units.yml

@@ -1,8 +1,8 @@
 extends: existence
 message: "Put a nonbreaking space between the number and the unit in '%s'."
-link: 'https://developers.google.com/style/units-of-measure'
+link: "https://developers.google.com/style/units-of-measure"
 nonword: true
 level: error
 tokens:
-  - \d+(?:B|kB|MB|GB|TB)
-  - \d+(?:ns|ms|s|min|h|d)
+  - \b\d+(?:B|kB|MB|GB|TB)
+  - \b\d+(?:ns|ms|s|min|h|d)

docs/styles/Microsoft/Contractions.yml

@@ -22,7 +22,7 @@ swap:
 
   should not: shouldn't
 
-  'that is(?!\.)': that's
+  "that is(?![.,])": that's
   'that''s(?=\.)': that is
 
   'they are(?!\.)': they're

docs/styles/Microsoft/Foreign.yml

@@ -9,4 +9,5 @@ action:
 swap:
   '\b(?:eg|e\.g\.)[\s,]': for example
   '\b(?:ie|i\.e\.)[\s,]': that is
-
+  '\b(?:viz\.)[\s,]': namely
+  '\b(?:ergo)[\s,]': therefore

docs/styles/Microsoft/Plurals.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Don't add '%s' to a singular noun. Use plural instead."
+ignorecase: true
+level: error
+link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/s-es
+raw:
+  - '\(s\)|\(es\)'

docs/styles/Microsoft/Terms.yml

@@ -1,5 +1,7 @@
 extends: substitution
 message: "Prefer '%s' over '%s'."
+# term preference should be based on microsoft style guide, such as
+link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/adapter
 level: warning
 ignorecase: true
 action:
@@ -24,10 +26,8 @@ swap:
   anti-spyware: antispyware
   anti-virus: antivirus
   appendixes: appendices
-  artificial intelligence: artificial intelligence
-  assembler: assembly language
-  bpp: bpp
-  bps: bps
+  artificial intelligence: AI
+  '(?:assembler|machine language)': assembly language
   caap: CaaP
   conversation-as-a-platform: conversation as a platform
   eb: EB
@@ -39,5 +39,3 @@ swap:
   pb: PB
   tb: TB
   zb: ZB
-  viz: namely
-  ergo: therefore

docs/styles/Vocab/edgeless/accept.txt → docs/styles/config/vocabularies/edgeless/accept.txt

@@ -1,9 +1,8 @@
-aesm
 AESM
 Alibaba
-[Aa]rgv
+argv
 auto-injection
-[Cc]loud
+cloud
 collateral
 config
 CPU
@@ -12,33 +11,32 @@ emojivoto
 Env
 Equinix
 glibc
-[Gg]ramine
+Gramine
 hardcode
 helloworld
 hostname
 IP
 Istio
 kubectl
 Linkerd
-minikube
 MarbleRun
-marblerun
+minikube
 namespace
 nginx
 nonce
 Occlum
-[Pp]remain
 precheck
-runtime
+premain
 Redis
+runtime
 subcommand
 Tensorflow
 toleration
 toolchain
 uncomment
 updatable
-vSphere
 VM
+vSphere
 walkthrough
 Xeon
 XORed