Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-24 22:07:23 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
564c309b11
VictoriaMetrics/cspell/README.md
Arkadii Yakovets fabf0b928e
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>
2024-07-11 12:39:42 +02:00

327 B
Raw Blame History

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.