Aliaksandr Valialkin
45cf83cd8f
Revert "docs: Add spellcheck workflow ( #6470 )"
...
This reverts commit 92b22581e6
.
Reason for revert: too complex and slow approach for spellchecking task.
This approach may significantly slow down development pace. It also may take non-trivial
amounts of additional time and resources at CI/CD because of all this npm shit at cspell directory.
Note to @arkid15r : the idea with the ability to run spellchecker on all the VictoriaMetrics
codebase is great. But this shouldn't be mandatory pre-commit check. It is enough to have
a Makefile rule like `make spellcheck`, which could be run manually whenever spellcheck is needed
(e.g. once per month or once per quarter).
2024-06-25 02:23:48 +02:00
Arkadii Yakovets
92b22581e6
docs: Add spellcheck workflow ( #6470 )
...
### Describe Your Changes
This is a follow-up PR containing workflow related part of the initial
[PR#6362](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6362 ).
It adds spell checking control based on
[cspell](https://github.com/streetsidesoftware/cspell ). The related
configs are consolidated under `cspell` directory.
You can add VictoriaMetrics specific terms into `cspell/custom-dict.txt`
(it contains ~30 items atm). All other absent commonly used terms should
be added directly to respective
[cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/blob/main/CONTRIBUTING.md ).
### 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>
2024-06-21 11:56:20 -07:00
Github Actions
ff513b40c0
Automatic update operator docs from VictoriaMetrics/operator@32f7674 ( #6414 )
2024-06-06 10:20:11 +08:00
Arkadii Yakovets
c740a8042e
docs: fix docs/ and README.md spelling errors ( #6362 )
...
Fixes `docs/` and `README.md` typos and errors.
Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
2024-06-03 10:04:13 +02:00
Github Actions
cba2f6dce1
Automatic update operator docs from VictoriaMetrics/operator@73a1996 ( #6100 )
2024-04-13 10:04:25 +08:00
Github Actions
0af5f88744
Automatic update operator docs from VictoriaMetrics/operator@4791fd1 ( #5843 )
2024-02-21 12:52:32 +01:00
Artem Navoiev
a200aaf0ef
docs fix broken links in operator
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-10-14 15:17:17 +02:00
Github Actions
b576acff5e
Automatic update operator docs from VictoriaMetrics/operator@26d1b3b ( #5130 )
2023-10-05 12:43:28 +02:00
Github Actions
cd0683a3af
Automatic update operator docs from VictoriaMetrics/operator@9fb79f4 ( #5124 )
2023-10-04 17:03:50 +02:00
Artem Navoiev
c21863a956
add hugo front matter for operator docs ( #5122 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-10-04 15:27:40 +02:00
Github Actions
62de314510
Automatic update operator docs from VictoriaMetrics/operator@c7125bd ( #5102 )
2023-10-02 14:50:08 +02:00