Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/vale-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Vale

on:
pull_request:
paths:
- 'main/**/*.md'
- 'main/**/*.mdx'
- 'main/**/*.jsx'
- 'auth4genai/**/*.md'
- 'auth4genai/**/*.mdx'
- 'auth4genai/**/*.jsx'

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- name: Install mdx2vast
run: npm install -g mdx2vast

- uses: actions/checkout@v4
- uses: errata-ai/vale-action@v2.1.1
with:
vale_flags: "--glob=!{main/docs/fr-ca/*,main/docs/ja-jp/*}"
fail_on_error: true
7 changes: 5 additions & 2 deletions auth4genai/.vale.ini → .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@

StylesPath = .vale/styles

; Primary vocabulary and all domain-specific vocabularies
Vocab = Abbreviations, ApiProtocols, AuthSecurity, Brands, CodeTerms, Cryptography, Databases, DevTools, FileFormats, Frameworks, Miscellaneous, MobileHardware, OperatingSystems, PackageManagers, Platforms, SocialMedia, TeamMembers, TechnicalConcepts

; Only report error-level issues. Suggestions and warnings are suppressed
; entirely so devs are not blocked on minor style nits.
MinAlertLevel = error
Expand All @@ -49,7 +52,7 @@ BasedOnStyles = Vale, AuthDocs

; Keep helpful core rules for terminology consistency and
; repeated word detection across the docs.
Vale.Terms = YES
Vale.Terms = NO
Vale.Repetition = YES

; Replace the built-in spelling rule with a custom one that knows about our
Expand All @@ -71,7 +74,7 @@ AuthDocs.Brands = YES
BasedOnStyles = Vale, AuthDocs

; Keep behavior consistent with MDX files.
Vale.Terms = YES
Vale.Terms = NO
Vale.Repetition = YES

; Use the same custom spelling + brand rules as MDX.
Expand Down
4 changes: 2 additions & 2 deletions auth4genai/.vale/README.md → .vale/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vale Linting

This directory contains the Vale configuration used to lint and standardize the documentation in `auth4genai`. Vale helps ensure consistent terminology, brand usage, spelling, and overall prose quality.
This directory contains the Vale configuration used to lint and standardize the documentation in `docs-v2`. Vale helps ensure consistent terminology, brand usage, spelling, and overall prose quality.

## Requirements

Expand Down Expand Up @@ -29,7 +29,7 @@ npm install -g mdx2vast

Both executables must be available in your `$PATH`.

Run Vale from the `auth4genai` directory:
Run Vale from the `docs-v2` directory:

```bash
vale .
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ level: error
scope: text

ignore:
- config/ignore/authdocs.txt
- config/ignore/authdocs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ authorizer
authorizers
Auditability
Backchannel
backchannel
chatbot
chatbots
fullstack
Expand Down
26 changes: 26 additions & 0 deletions .vale/styles/config/vocabularies/Abbreviations/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
CA
CLI
cms
cql
dns
DNS
eg
HTML
ie
ip
IP
ISPs
mcp
MDoc
mDoc
OSs
SDK
se
SIEMs
SLAs
sms
TLDs
uat
UAT
UIs
VMs
24 changes: 24 additions & 0 deletions .vale/styles/config/vocabularies/ApiProtocols/accept.txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✋🏽 Change Request: There are some duplications in this file for terms already in the CodeTerms/ folder. Can we use claude to validate there are no duplicates.

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
ACLs
API
apis
configs
conformant
CVEs
DSARs
form_id
getPets
http
https
last_ip
log_id
max_age
maxAge
oid
org_id
param
params
Params
postUrl
url
urls
WSFed
80 changes: 80 additions & 0 deletions .vale/styles/config/vocabularies/AuthSecurity/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
addon
Addon
Addons
adfs
Captcha
CAPTCHAs
captcha
clickjacking
Clickjacking
cnf
cors
CORs
cybersecurity
Cybersecurity
DPop
Failover
failover
gdpr
HSMs
IdP
Idp
IDP
idp
idToken
JWKs
JWT
jwt
JWTs
Kerberos
keypair
keystore
Keystores
Keystore
ldap
ldaps
Mfa
mfa
Multifactor
multifactor
Multitenancy
Multitenant
multitenant
nonces
oidc
Onboarding
onboarding
openid
otp
OTP
OTPs
passcode
passcodes
passwordless
passwordlessMethod
rbac
reauthenticate
reauthentication
Reauthentication
Rekey
rekey
saml
Saml
SAMLRequest
samlConfiguration
scim
signin
signup
Signup
signups
Signups
sso
SSOdata
Unenroll
unencrypted
Unencrypted
unlinking
Unlinking
untrusted
upn
Webauthn
72 changes: 72 additions & 0 deletions .vale/styles/config/vocabularies/Brands/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Akamai
Alterian
Apigee
Atlassian
Authy
Caddy
Cloudfare
Cloudwatch
Cocoapods
Cognito
Contoso
Criipto
Datadog
Datatracker
Egencia
Eloqua
Evernote
Fabrikam
Flickr
Freshdesk
Freshworks
Gigya
Github
Gravatar
hCaptcha
Inngest
iWelcome
Kantara
Keycloak
Kibana
Kickstarter
Litmos
Logentries
Loggly
Logstash
Mailchimp
Mailgun
Mailjet
Marketo
Mixpanel
Netlify
Okta
Papertrail
Papertrail's
Pluralsight
Pubnub
RCDevs
Runscope
Sailthru
Sendgrid
Sharepoint
Sparkpost
Splunk
SSOCircle
Stormpath
Symplified
Syslog
Tessel
tiktok
Twilio
Twillio
Ubisecure
Unbounce
vscode
Webex
Windowslive
Wordpress
Workpath
Yubico
Zendesk
Zipline
Ziplines
Loading
Loading