Skip to content

Commit d1432a4

Browse files
committed
augmented spellcheck wordlist
Signed-off-by: Frederic BIDON <[email protected]>
1 parent 760cb97 commit d1432a4

File tree

3 files changed

+59
-7263
lines changed

3 files changed

+59
-7263
lines changed

.github/.wordlist.txt

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,106 @@
11
API
2+
BSON
23
CI
4+
CIDR
5+
CLI
36
DCO
47
DockerHub
58
FAQ
9+
GC
10+
GoDoc
11+
Godoc
612
HUGO
713
ID
814
IDs
15+
IP
16+
IPs
17+
ISBN
18+
Kubernetes
919
Markdown
1020
OAI
1121
OpenAPI
1222
PR
1323
PRs
24+
README
25+
SSN
1426
TODO
1527
UI
28+
ULID
29+
URI
30+
URL
1631
USD
32+
UUID
1733
api
1834
assignees
35+
backquote
36+
backquoted
1937
bash
38+
benchmarking
2039
bitmask
40+
bson
2141
ci
42+
cidr
2243
codecov
44+
codegen
2345
config
46+
customizable
2447
dependabot
2548
docker
49+
e.g.
2650
faq
51+
flattener
2752
fuzzying
53+
gc
2854
github
2955
go-openapi
56+
godoc
3057
golang
3158
golangci
59+
hostname
3260
html
3361
http
3462
https
3563
hugo
64+
i.e.
3665
id
66+
initialism
67+
initialisms
68+
ipsum
69+
ipsums
70+
ipv4
71+
ipv6
72+
isbn
3773
json
3874
jsonschema
75+
k8s
76+
kubernetes
3977
linter
4078
linters
79+
loren
4180
markdown
81+
marshaling
82+
mixin
4283
oai
4384
openapi
4485
repo
4586
repos
4687
schema
88+
schemas
89+
sexualized
90+
ssn
91+
submodule
92+
subpackage
4793
swagger
4894
toolchain
4995
ui
96+
ulid
97+
unmarshaling
98+
untyped
99+
uri
100+
url
50101
utf-8
102+
uuid
103+
validator
104+
workspace
105+
workspaces
51106
yaml

.github/workflows/doc-update.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ name: doc update check
2424
# * [ ] in this case, instead of commenting pull requests, it should raise issues.
2525
# * [ ] should be able to retrieve config files and dictionary from the called ref, not master.
2626
# * [ ] should be able to merge config files and dictionary with local definitions on target repo.
27+
# * [ ] should be able to work on diff
2728

2829
on:
2930
workflow_call:
@@ -451,7 +452,9 @@ jobs:
451452
452453
echo "### Changed markdown docs show some mispelled words. ⚠️" >> $GITHUB_STEP_SUMMARY
453454
echo "" >> $GITHUB_STEP_SUMMARY
454-
echo "> ℹ️ INFO: we use [rojopolis/spellcheck-github-actions](https://github.com/rojopolis/spellcheck-github-actions)" >> $GITHUB_STEP_SUMMARY
455+
echo "> ℹ️ INFO: we use [rojopolis/spellcheck-github-actions](https://github.com/rojopolis/spellcheck-github-actions)." >> $GITHUB_STEP_SUMMARY
456+
echo ">" >> $GITHUB_STEP_SUMMARY
457+
echo "> As a general rule, technical terms or acronyms and references to code objects should be backquoted in markdown" >> $GITHUB_STEP_SUMMARY
455458
456459
- name: Upload comment as artifact
457460
# description: |

0 commit comments

Comments
 (0)