Skip to content

Commit abb1a0b

Browse files
Add documentation checker CI workflow
1 parent 41d64fc commit abb1a0b

File tree

4 files changed

+164
-0
lines changed

4 files changed

+164
-0
lines changed

.github/.wordlist.txt

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
AddressString
2+
adoc
3+
ansible
4+
AppModule
5+
AssumeColonVerbOpt
6+
auth
7+
awk
8+
backend
9+
cli
10+
ConsensusVersion
11+
dcl
12+
dcld
13+
DDoS
14+
debuglineerr
15+
dev
16+
distributedcomplianceledger
17+
dlv
18+
Dockerfile
19+
EditorIntegration
20+
gdbwire
21+
getent
22+
golang
23+
grpc
24+
gw
25+
hotfixes
26+
href
27+
https
28+
img
29+
init
30+
InvalidArgument
31+
IsKeyNotFoundRpcError
32+
IsWriteInsteadReadRpcError
33+
JSON
34+
linter
35+
lldbout
36+
localnet
37+
MainNet
38+
multiclient
39+
NotFound
40+
ol
41+
openapi
42+
opensource
43+
permissioned
44+
pki
45+
png
46+
PoA
47+
postinstall
48+
pre
49+
proto
50+
puml
51+
QueryWithProof
52+
quickStartGuide
53+
readme
54+
rpc
55+
runtime
56+
sdk
57+
src
58+
starport
59+
svg
60+
tendermint
61+
Tendermint's
62+
TLS
63+
txn
64+
ui
65+
uint
66+
uncomment
67+
untrusted
68+
usr
69+
ValidateBasic
70+
validator
71+
validators
72+
VN
73+
yml
74+
ZB
75+
zigbee

.github/workflows/spell.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# Copyright 2022 Samsung Corporation
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
name: Documentation CI workflow
17+
# yamllint disable-line rule:truthy
18+
on:
19+
push:
20+
paths:
21+
- '**.md'
22+
pull_request:
23+
paths:
24+
- '**.md'
25+
workflow_dispatch:
26+
27+
jobs:
28+
check-markdown-links:
29+
name: Run markdown-link-check tool to verify link issues
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@master
33+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
34+
check-spellcheck:
35+
name: Run PySpelling tool to verify spelling issues
36+
runs-on: ubuntu-latest
37+
steps:
38+
- uses: actions/checkout@v2
39+
- uses: rojopolis/spellcheck-github-actions@0.22.1
40+
check-super-linter:
41+
name: Run textlint tool to verify natural language issues
42+
runs-on: ubuntu-latest
43+
steps:
44+
- uses: actions/checkout@v2
45+
- uses: github/super-linter@v4
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
LINTER_RULES_PATH: /
49+
VALIDATE_NATURAL_LANGUAGE: true

.spellcheck.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# Copyright 2022 Samsung Corporation
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
matrix:
17+
- name: English content
18+
sources:
19+
- '*.md'
20+
default_encoding: utf-8
21+
aspell:
22+
lang: en
23+
ignore-case: true
24+
dictionary:
25+
wordlists:
26+
- .github/.wordlist.txt
27+
output: /tmp/aspell.dic
28+
encoding: utf-8
29+
pipeline:
30+
- pyspelling.filters.markdown:

.textlintrc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"rules": {
3+
"terminology": {
4+
"exclude": [
5+
"Node(?:js)?",
6+
"HTML",
7+
]
8+
}
9+
}
10+
}

0 commit comments

Comments
 (0)