github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-01 14:47:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/cspell
History
Arkadii Yakovets 8645b2cc8e
docs: add spellcheck command (#6562) 
### Describe Your Changes

Implement spellcheck command:
  - add cspell configuration files
  - dockerize spellchecking process
  - add Makefile targets

This PR adds a standalone `make spellcheck` target to check `docs/*.md` files for spelling
errors. The target process is dockerized to be run in a separate npm environment.

Some `docs/` typo fixes also included.

### Checklist

The following checks are **mandatory**:

- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).

---------

Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit fabf0b928e)
2024-07-11 12:40:24 +02:00
..
cspell.json docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
custom-dict.txt docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
Dockerfile docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
Makefile docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
package-lock.json docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
package.json docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00
README.md docs: add spellcheck command (#6562) 2024-07-11 12:40:24 +02:00

README.md

Spell checking

This directory contains configuration and instructions for spell checking in docs folder.

To run execute the following command:

make cspell-check

This command required Docker to build cspell image and run the spell checks.