codespell/README.md

# 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 spellcheck
```

This command required Docker to build `spellcheck` image and run the spell checks.
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 03:39:42 -07:00			`# 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
spelling and grammar fixes via codespell (#8497) ### Describe Your Changes Fix many spelling errors and some grammar, including misspellings in filenames. The change also fixes a typo in metric `vm_mmaped_files` to `vm_mmapped_files`. While this is a breaking change, this metric isn't used in alerts or dashboards. So it seems to have low impact on users. The change also deprecates `cspell` as it is much heavier and less usable. --------- Co-authored-by: Andrii Chubatiuk <achubatiuk@victoriametrics.com> Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com> 2025-03-17 16:32:10 +01:00			`make spellcheck`
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 03:39:42 -07:00			```

spelling and grammar fixes via codespell (#8497) ### Describe Your Changes Fix many spelling errors and some grammar, including misspellings in filenames. The change also fixes a typo in metric `vm_mmaped_files` to `vm_mmapped_files`. While this is a breaking change, this metric isn't used in alerts or dashboards. So it seems to have low impact on users. The change also deprecates `cspell` as it is much heavier and less usable. --------- Co-authored-by: Andrii Chubatiuk <achubatiuk@victoriametrics.com> Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com> 2025-03-17 16:32:10 +01:00			This command required Docker to build `spellcheck` image and run the spell checks.