Skip to content

Commit

Permalink
enable: markdown lint + check: links + spelling (#308)
Browse files Browse the repository at this point in the history
#### What this PR does / why we need it:

This better public relation, when all links are working and there are no
typing errors.

#### Which issue(s) this PR fixes:

Some of the issues will be fixed as soon as
open-component-model/ocm#871 is merged.

---------

Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
  • Loading branch information
hilmarf and morri-son authored Sep 16, 2024
1 parent 016613a commit 19218cb
Show file tree
Hide file tree
Showing 100 changed files with 1,016 additions and 671 deletions.
2 changes: 2 additions & 0 deletions .github/config/markdownignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/content/docs/cli-reference
/content/docs/controller/controller-reference
6 changes: 6 additions & 0 deletions .github/config/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
default: true

MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033
MD024:
siblings_only: true #Multiple headers with the same content
22 changes: 22 additions & 0 deletions .github/config/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
matrix:
- name: Markdown
aspell:
lang: en
ignore-case: true
mode: markdown
dictionary:
wordlists:
- .github/config/wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- '**/*.md'
default_encoding: utf-8
290 changes: 290 additions & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
accessmethod
accessmethoddescriptor
accessmethods
actiondescriptor
additionalresource
addversion
adr
aggregative
aml
anchore
api
archlinux
artifactid
aur
auth
autoconfigure
aws
backend
backends
basename
bindata
blobaccess
blobhandler
bool
boolean
buildx
cas
cli
cliconfig
clis
closable
closeable
cmds
cncf
codeql
commontransportarchive
componentaccess
componentaccessimpl
componentarchive
componentreferences
componentversionaccess
componentversionaccessimpl
componentversions
compvers
config
configfile
configs
consumerid
containerd
crd
creationtime
credentialrequest
credentialsspec
crossplatform
crypto
ctf
ctfs
ctx
cvs
deepcopy
defs
dependabot
deployscript
deserializable
deserialization
deserialize
deserialized
dest
digesters
directorytree
dirtree
dns
dockerconfig
downloadconstraint
downloader
downloaderdescriptor
downloaders
downloadhandlers
dry-run
dup
dups
dynaml
echoserver
entrypoint
executables
executoroptions
executorspecification
extensibility
filepath
filesystem
filesytem
finalizer
finalizers
foldername
forwardspec
gapped
gav
getinexpensivecontentversionidentity
getresourcesbyname
getter
ghcr
github
gitignore
gitops
globalaccess
globals
gocritic
gofmt
golang
golangci
gomega
goreleaser
gosec
goutils
groupid
gzip
handleoutput
hashers
hashicorp
hashicorpvault
helmchart
helmchartrepository
helmdemo
helmexecutor
helminstaller
helmrepository
hoc
homebrew
hostname
hostpath
html
http
https
iaas
imagemapping
inlined
installable
instantiation
io
ioutils
iterable
json
jsonschema
keyless
keypair
keyring
kubebuilder
kubeconfig
kubernetes
labelmergespecification
lifecycle
linter
linters
lister
listers
localizations
logconfig
logrus
lookups
macos
makefile
makefiles
mandelsoft
mapocirepoattr
matcher
matchers
mavenartifact
mavenpackage
mavenrepository
mediatype
mimetype
mimetypes
multiarch
mutex
mvn
mvnrepository
namespace
namespaces
newcomponentaccess
newcomponentversionaccess
newrepository
newrepositoryspec
npm
npmjs
npmrc
npmregistry
oauth
oci
ociartifact
ocireg
ociregistry
ocm
ocmbot
ocmcli
ocmconfig
oncefunc
oo
oras
os
outputspecification
packagespec
parameterization
pendingdeprecationwarning
pflag
podinfo
podman
pre
preconfigure
preconfigured
predefine
programmatically
prs
pss
pubsub
readme
readonly
refcount
relativeocireference
releaser
repo
repocpi
repositoryimpl
repositoryspec
resendbuffer
resolvers
resourcereference
routings
routingslips
rsa
rsakeypair
runtime
sbod
sbom
sdk
semver
sequent
serializable
sha
signingserver
sigstore
simplemapmerge
sonatype
spdx
srcrefs
stderr
stdin
stdout
storable
struct
subchart
subcharts
subst
tempfile
templated
templater
templaters
templating
tgz
tls
todo
toi
toiexecutor
toolset
transportarchive
typehandler
typename
unmodifiable
untrusted
updatevendorhash
uploader
uploaderdescriptor
uploaders
uploadhandlers
url
urls
utf
util
utils
valuemergehandler
valuemergehandlerdescriptor
valueset
versionedtypedobjects
walkthrough
wget
withocm
xml
yaml
yitsushi
yml
yyyy
Loading

0 comments on commit 19218cb

Please sign in to comment.