mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-01 14:47:38 +00:00
8645b2cc8e
### 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)
11 lines
No EOL
327 B
Markdown
11 lines
No EOL
327 B
Markdown
# Spell checking
|
|
|
|
This directory contains configuration and instructions for spell checking in
|
|
[docs](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs) folder.
|
|
|
|
To run execute the following command:
|
|
```sh
|
|
make cspell-check
|
|
```
|
|
|
|
This command required Docker to build `cspell` image and run the spell checks. |