feat: TechDocs - Add vale linter to check words quality in md files. (#2631)

* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
This commit is contained in:
Mayursinh Sarvaiya
2020-10-02 10:50:47 +05:30
committed by GitHub
parent 73440c7d9a
commit 5c6a0356c0
22 changed files with 336 additions and 21 deletions
+203
View File
@@ -0,0 +1,203 @@
abc
Apdex
api
Api
apis
args
asciidoc
async
Avro
backrub
Balachandran
Bigtable
Blackbox
bool
boolean
Chai
changeset
changesets
Changesets
changset
chanwit
Chanwit
cisphobia
cissexist
classname
cli
cncf
codeblocks
Codecov
codehilite
Codehilite
codeowners
config
Config
configs
const
cookiecutter
css
dariddler
deadnaming
destructured
dev
devs
discoverability
Discoverability
dls
docgen
Dockerfile
Dockerize
dockerode
Docusaurus
eg
Ek
env
Env
eslint
facto
failover
Figma
Firekube
Fredrik
github
Github
Gitlab
graphql
graphviz
Hackathons
haproxy
heroku
Hostname
http
https
img
incentivised
inlinehilite
interop
javascript
Javascript
jq
js
json
jsx
Kaewkasi
Knex
kubectl
kubernetes
learnings
lerna
Lerna
magiclink
mailto
Malus
md
microsite
middleware
minikube
Minikube
misgendering
mkdocs
Mkdocs
monorepo
Monorepo
monorepos
msw
namespace
Namespaces
neuro
newrelic
nginx
Niklas
nohoist
nonces
npm
nvm
oauth
Oauth
Okta
Oldsberg
onboarding
Onboarding
pagerduty
Patrik
Phoen
plantuml
Pomaceous
postgres
pre
prebaked
preconfigured
Preprarer
Prerequisities
productional
Protobuf
proxying
Proxying
pygments
pymdownx
Raghunandan
rankdir
readme
Readme
Redash
repo
Repo
repos
rerender
rollbar
Rollbar
Rollup
Rosaceae
rst
rsync
ruleset
sam
scaffolded
scaffolder
Scaffolder
semlas
Serverless
Sinon
smartsymobls
sparklines
Spotifiers
spotify
Spotify
squidfunk
src
subkey
superfences
Superfences
talkdesk
Talkdesk
tasklist
techdocs
templated
templater
Templater
templaters
Templaters
Thauer
theres
toc
tolerations
Tolerations
toolsets
touchpoints
ui
upvote
url
utils
validators
Voi
Wealthsimple
Weaveworks
xyz
yaml
Zalando
Zhou
Billett
cloudbuild
Grafana
Iain
Snyk
@@ -0,0 +1,18 @@
name: Check Markdown files quality
on:
pull_request:
branches: [master]
paths:
- '**.md'
jobs:
check-all-files:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: documentation quality check
uses: errata-ai/vale-action@v1.3.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}