docs: integrate Vale for documentation linting (#2242)

* added value rules

* resolved errors raised by vale

* added github action

* fixes to github action

* added details in contribution guidelines

* added rule for numbers

* limited checks to errors
This commit is contained in:
Shahed Nasser
2022-09-22 13:12:09 +03:00
committed by GitHub
parent d0d789b6d4
commit 6adaf56c73
103 changed files with 2408 additions and 832 deletions
+28
View File
@@ -0,0 +1,28 @@
#!/bin/bash
list=""
alertLevel=$1
if [ ${#alertLevel} -eq 0 ]; then
alertLevel="suggestion"
fi
# get directories in content other than reference
for i in `find content -type d -maxdepth 1 -not -path 'content/references' -not -path 'content'`
do
if [ ${#list} -gt 0 ]; then
list+=' '
fi
list+="docs/$i"
done
#get files in content (not nested)
for i in `find content -type f -maxdepth 1 -not -path 'content/references'`
do
if [ ${#list} -gt 0 ]; then
list+=' '
fi
list+="docs/$i"
done
cd ..
exec vale $list --minAlertLevel $alertLevel