Skip to content

Commit a6593ee

Browse files
HClowardckoegel
authored andcommittedDec 3, 2024
docs: adds vale rules and workflow for running in CI (Redocly#2348)
* docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc
1 parent c57cb88 commit a6593ee

File tree

3 files changed

+166
-0
lines changed

3 files changed

+166
-0
lines changed
 

‎.github/styles/Vocab/Rules/accept.txt

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
[Aa]nsible
2+
[Aa]utostart
3+
[Bb]locklist
4+
[Bb]locklists
5+
[Bb]oolean
6+
[Bb]reakpoint
7+
[B]reakpoints
8+
[Cc]ancelation
9+
[Cc]lassloading
10+
[Cc]hargeback
11+
[Cc]hargebacks
12+
[Cc]he
13+
[Cc]rypto
14+
[Cc]ryptocurrency
15+
[Dd]evfile|[Dd]evfiles
16+
[Dd]ownstream
17+
[Dd]ownstreaming
18+
[Ff]actories|[Ff]actory
19+
[Gg]it
20+
[Gg]rafana
21+
[Hh]eatmap
22+
[Hh]elm
23+
[Hh]ostname
24+
[Ii]tem
25+
[Jj]etbrains
26+
[Kk]eycloak
27+
[Ll]iveness
28+
[Ll]ombok
29+
[Ll]oopback
30+
[Mm]aven
31+
[Mm]inikube
32+
[Mm]inishift
33+
[Mm]ixin|[Mm]ixins
34+
[Mm]odularization
35+
[Mm]ulticluster
36+
[Mm]ultihost
37+
[Mm]ultinode
38+
[Mm]ultitenant
39+
[Mm]ultiuser
40+
[Mm]ultizone
41+
[Nn]amespace|[Nn]amespaces
42+
[Nn]etcoredebug[Oo]utput
43+
[Nn]ginx
44+
[Oo]nboarding
45+
[Pp]podman
46+
[Pp]reconfigured
47+
[Rr]eadonly
48+
[Rr]epresentment
49+
[Rr]ollout|[Rr]ollouts
50+
[Rr]untime|[Rr]untimes
51+
[Ss]erializer
52+
[Ss]erverless
53+
[Ss]ubnetwork
54+
[Ss]ubpath|[Ss]ubpaths
55+
[Tt]heia
56+
[Tt]olerations
57+
[Tt]ruststore
58+
[Uu]ninstallation
59+
[Uu]nstaged
60+
[Uu]ntrusted
61+
[Ww]orkspace|[Ww]orkspaces
62+
[Yy]eoman
63+
\.NET
64+
adoc
65+
Antora
66+
API
67+
Apigee
68+
AsciiDoc
69+
AWS|aws
70+
Azure
71+
Bierner
72+
Bitbucket
73+
btn
74+
Btrfs
75+
CentOS
76+
Ceph
77+
Che-Theia
78+
CLI
79+
ConfigMap|ConfigMaps
80+
Ctrl
81+
DaemonSet
82+
Dev Workspace
83+
Developer Perspective
84+
DNS
85+
Docker
86+
Dockerfile
87+
Dotnet
88+
Endevor
89+
endif
90+
GitHub|github
91+
GitLab
92+
Gluster
93+
Gradle
94+
Grafana
95+
GUI
96+
HTTPS|https
97+
I/O
98+
IDE|ide|IDEs
99+
Intelephense
100+
IntelliJ IDEA
101+
Java
102+
Java Lombok
103+
JSON|json
104+
JVM|jvm
105+
kbd
106+
Kubespray
107+
Laravel
108+
Let\'s Encrypt
109+
Mattermost
110+
mebibytes
111+
Microsoft Azure
112+
millicores
113+
Mulesoft
114+
MySQL
115+
Netlify
116+
Node.js
117+
npm
118+
NuGet
119+
OAuth
120+
ocp
121+
OmniSharp
122+
OpenShift
123+
OpenTracing
124+
Operator
125+
OperatorHub
126+
OpenAPI
127+
osd
128+
PHP
129+
PostgreSQL
130+
Quarkus
131+
Rebilly
132+
Redoc
133+
Redocly
134+
Redocly-cli
135+
SCM
136+
Sharding
137+
SonarLint
138+
Spring Boot
139+
SVG
140+
Uber
141+
URI|URIs
142+
URL|url|URLs
143+
Velero
144+
Vercel
145+
Visual Studio Code
146+
vsix
147+
Webview|Webviews
148+
Woopra
149+
YAML|yaml
150+
Zowe

‎.github/styles/Vocab/Rules/reject.txt

Whitespace-only changes.

‎.github/workflows/vale.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Docs lint
2+
on:
3+
pull_request:
4+
types: [opened, synchronize, reopened]
5+
6+
jobs:
7+
vale:
8+
name: vale action
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: errata-ai/vale-action@reviewdog
13+
with:
14+
files: '["README.md", "docs"]'
15+
env:
16+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

0 commit comments

Comments
 (0)
Please sign in to comment.