Commit Graph

32 Commits

Author SHA1 Message Date
Github Actions
3d6e3ee98f
Automatic update operator docs from VictoriaMetrics/operator@0c311bb () 2024-07-04 11:46:16 +02:00
Josh Keife
bdebc128f7
Update vmalert.md ()
Fix typo

### Describe Your Changes

Fix typo in the vmalert docs. In the docs it states rules at `VMAgent`'s
namespace when it should be `VMAlert`'s namespace.

### Checklist

The following checks are **mandatory**:

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

(cherry picked from commit 8d01dd0514)
2024-06-27 09:32:07 +02:00
Aliaksandr Valialkin
813a7aec6c
docs: return back spellcheck fixes from the commit 92b22581e6, which were accidentally reverted in 45cf83cd8f
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6470
2024-06-25 02:33:59 +02:00
Aliaksandr Valialkin
7f2b491748
Revert "docs: Add spellcheck workflow ()"
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:28:38 +02:00
Arkadii Yakovets
c454084eb1
docs: Add spellcheck workflow ()
### 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>
(cherry picked from commit 92b22581e6)
2024-06-24 12:50:13 +02:00
Github Actions
2e3c039113
Automatic update operator docs from VictoriaMetrics/operator@32f7674 () 2024-06-06 12:12:58 +02:00
Arkadii Yakovets
a6655322b1
docs: fix docs/ and README.md spelling errors ()
Fixes `docs/` and `README.md` typos and errors.

Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>

(cherry picked from commit c740a8042e)
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 11:53:33 +02:00
Github Actions
f22b2a0563
Automatic update operator docs from VictoriaMetrics/operator@8f025b3 ()
Co-authored-by: Hui Wang <haley@victoriametrics.com>
(cherry picked from commit e908effd22)
2024-04-30 10:30:10 +02:00
Github Actions
ff0a1eb3e6
Automatic update operator docs from VictoriaMetrics/operator@6e1a876 ()
(cherry picked from commit a14acd4fcc)
2024-04-24 17:08:21 +02:00
Github Actions
a0b1c95787
Automatic update operator docs from VictoriaMetrics/operator@731de81 ()
Co-authored-by: Alexander Marshalov <_@marshalov.org>
2024-04-19 11:35:21 +02:00
Github Actions
4859f5eeed
Automatic update operator docs from VictoriaMetrics/operator@73a1996 ()
(cherry picked from commit cba2f6dce1)
2024-04-16 09:57:44 +02:00
Github Actions
26ed8d0571
Automatic update operator docs from VictoriaMetrics/operator@17082f0 () 2024-04-11 09:15:21 +02:00
7c4c6f7ee6
docs: fix a typo in docs/operator/resources/vmalert.md () 2024-04-11 09:09:26 +02:00
Thomas
7526f1d3a5
chore(docs): fix vmalertmanager typo ()
Fixes: 

Signed-off-by: Thomas Way <thomas@6f.io>
Co-authored-by: Alexander Marshalov <_@marshalov.org>
2024-04-04 00:39:53 +03:00
Github Actions
ee95e9d14d
Automatic update operator docs from VictoriaMetrics/operator@ac29c88 () 2024-04-02 23:45:41 +03:00
hagen1778
a1b666c35e
docs: add missing API version to VMSingle example
Signed-off-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit 93a29fce4e)
2024-03-25 15:42:51 +01:00
Github Actions
786679135b
Automatic update operator docs from VictoriaMetrics/operator@4791fd1 () 2024-02-23 00:40:04 +02:00
Github Actions
c952c678b2
Automatic update operator docs from VictoriaMetrics/operator@e261c37 () 2024-02-12 20:11:07 +02:00
Artem Navoiev
aee3e51315
docs: remove raw and endraw tags as they are not needed for the new v… ()
* docs: remove raw and endraw tags as they are not needed for the new version of site

Signed-off-by: Artem Navoiev <tenmozes@gmail.com>

* revert formating in vmaler

Signed-off-by: Artem Navoiev <tenmozes@gmail.com>

---------

Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 21:06:10 +01:00
Github Actions
4ccf3f41c6
Automatic update operator docs from VictoriaMetrics/operator@1470569 () 2024-01-23 17:47:36 +02:00
Jaskeerat Singh Randhawa
291802ea84
custom-resources: fix link text for alertmanager () 2024-01-23 02:30:51 +02:00
hagen1778
b04bb9b140
docs: fix unauthorizedAccessConfig filed names for operator
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5520

Signed-off-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit 8ba483eca3)
2023-12-22 16:10:31 +01:00
Github Actions
2a0717c8db
Automatic update operator docs from VictoriaMetrics/operator@f628bee ()
(cherry picked from commit 7ca783dee9)
2023-12-01 14:00:11 +01:00
Github Actions
4038a30d64
Automatic update operator docs from VictoriaMetrics/operator@e737115 () 2023-11-27 12:02:33 +02:00
Github Actions
28df725a37
Automatic update operator docs from VictoriaMetrics/operator@45bfa36 () 2023-11-22 20:25:46 +02:00
Github Actions
bf934482c5
Automatic update operator docs from VictoriaMetrics/operator@b96131b () 2023-11-22 19:23:15 +02:00
Artem Navoiev
146c4fc494
docs fix broken links in operator
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-10-16 13:43:56 +02:00
Github Actions
c488f225ec
Automatic update operator docs from VictoriaMetrics/operator@26d1b3b ()
(cherry picked from commit b576acff5e)
2023-10-05 14:59:51 +02:00
Github Actions
e20f969ed3
Automatic update operator docs from VictoriaMetrics/operator@9fb79f4 () 2023-10-04 17:57:25 +02:00
Artem Navoiev
12b0e3e5cb
add hugo front matter for operator docs ()
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-10-04 16:28:23 +02:00
Github Actions
025a53dcb6
Automatic update operator docs from VictoriaMetrics/operator@44bdc27 () 2023-10-02 20:36:21 +02:00
Github Actions
835393a59c
Automatic update operator docs from VictoriaMetrics/operator@c7125bd () 2023-10-02 20:36:21 +02:00