rms/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2026-06-28 13:07:50 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,694 Commits 229 Branches 1,007 Tags
a2fca24402bac0f0677b17841b8d43ce0cf8a9d5
Commit Graph

49 Commits

Author SHA1 Message Date
Github Actions
3eb8068b77 Automatic update operator docs from VictoriaMetrics/operator@9ef3d95 (#6596) 
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit f41f5ef62e)
 2024-07-09 10:52:57 +02:00
Github Actions
3d6e3ee98f Automatic update operator docs from VictoriaMetrics/operator@0c311bb (#6574) 2024-07-04 11:46:16 +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 (#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:28:38 +02:00
Arkadii Yakovets
c454084eb1 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>
(cherry picked from commit 92b22581e6)
 2024-06-24 12:50:13 +02:00
Github Actions
c96b334b3e Automatic update operator docs from VictoriaMetrics/operator@310a860 (#6449) 
(cherry picked from commit 020d3f3d88)
 2024-06-11 17:05:01 +02:00
Github Actions
2e3c039113 Automatic update operator docs from VictoriaMetrics/operator@32f7674 (#6414) 2024-06-06 12:12:58 +02:00
Arkadii Yakovets
a6655322b1 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>

(cherry picked from commit c740a8042e)
Signed-off-by: hagen1778 <roman@victoriametrics.com>
 2024-06-03 11:53:33 +02:00
Github Actions
ab5b233c3a Automatic update operator docs from VictoriaMetrics/operator@0829591 (#6250) 
(cherry picked from commit c87ce86d96)
 2024-05-10 14:32:18 +02:00
Github Actions
cc68484f95 Automatic update operator docs from VictoriaMetrics/operator@2789953 (#6237) 
(cherry picked from commit 55c7dafb35)
 2024-05-10 13:14:24 +02:00
Github Actions
bb667fd3f7 Automatic update operator docs from VictoriaMetrics/operator@6271553 (#6233) 
(cherry picked from commit 134dcaef33)
 2024-05-10 13:14:19 +02:00
Github Actions
f2897fb859 Automatic update operator docs from VictoriaMetrics/operator@e343a8e (#6168) 
(cherry picked from commit 301bd387d4)
 2024-04-23 14:52:33 +02:00
Github Actions
66f3f90f74 Automatic update operator docs from VictoriaMetrics/operator@781dbba (#6143) 2024-04-19 11:35:58 +02:00
Github Actions
3cb3a9c950 Automatic update operator docs from VictoriaMetrics/operator@7f6c6d8 (#6138) 2024-04-19 11:34:50 +02:00
Github Actions
60a447bb76 Automatic update operator docs from VictoriaMetrics/operator@99fbc98 (#6122) 2024-04-17 12:15:39 +02:00
Github Actions
20f16aed1a Automatic update operator docs from VictoriaMetrics/operator@cf48a99 (#6113) 
(cherry picked from commit 7db8ba41e7)
 2024-04-16 09:58:07 +02:00
Github Actions
4859f5eeed Automatic update operator docs from VictoriaMetrics/operator@73a1996 (#6100) 
(cherry picked from commit cba2f6dce1)
 2024-04-16 09:57:44 +02:00
Github Actions
26ed8d0571 Automatic update operator docs from VictoriaMetrics/operator@17082f0 (#6090) 2024-04-11 09:15:21 +02:00
Github Actions
ee95e9d14d Automatic update operator docs from VictoriaMetrics/operator@ac29c88 (#6022) 2024-04-02 23:45:41 +03:00
Github Actions
eb82f329cb Automatic update operator docs from VictoriaMetrics/operator@ae6e1b6 (#5964) 2024-03-17 23:16:52 +02:00
Github Actions
b530f6bf73 Automatic update operator docs from VictoriaMetrics/operator@c8ff654 (#5918) 2024-03-04 19:12:59 +02:00
Github Actions
5e20be845f Automatic update operator docs from VictoriaMetrics/operator@7e8f811 (#5902) 2024-02-29 17:53:11 +02:00
Github Actions
33a65d6988 Automatic update operator docs from VictoriaMetrics/operator@9f1c910 (#5895) 2024-02-29 13:56:31 +02:00
Github Actions
cd287b2e4c Automatic update operator docs from VictoriaMetrics/operator@0628def (#5694) 2024-01-26 21:05:13 +01:00
Github Actions
4ccf3f41c6 Automatic update operator docs from VictoriaMetrics/operator@1470569 (#5668) 2024-01-23 17:47:36 +02:00
Github Actions
3a96830ed6 Automatic update operator docs from VictoriaMetrics/operator@fec3f9d (#5381) 2023-11-23 21:06:27 +02:00
Github Actions
a35ae0716e Automatic update operator docs from VictoriaMetrics/operator@2c826bb (#5188) 2023-10-26 09:05:33 +02:00
Github Actions
700d83db93 Automatic update operator docs from VictoriaMetrics/operator@79298bf (#5177) 2023-10-16 13:56:49 +02:00
Aliaksandr Valialkin
dfc67aedcb lib/license: cleanups and prettifications for log messages and docs related to licensing 
- Make more clear the docs at docs/enterprise.md, so readers could figure out faster
  on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components.

- Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag.
  The `-licenseFile` command-line flag must be used instead.

- Improve the description of `-license*` command-line flags, so users could understand
  faster how to use them.

- Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed,
  so the user could figure out how to switch faster to -license* command-line flags.

- Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags.

- Disallow running VictoriaMetrics components when -licensFile points to an empty file.

- Consistently use the phrase "This flag is available only in Enterprise binaries" across
  all the enterprise-specific command-line flags.

- Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants
  in order to improve code readability and maintainability.

- Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return.

- Make sure that the info log message about successful license verification is emitted
  when the license is verified successfully. Previously the error message could be logged
  when the license payload is invalid or if it misses some required features.
 2023-10-16 12:51:37 +02:00
Github Actions
c488f225ec Automatic update operator docs from VictoriaMetrics/operator@26d1b3b (#5130) 
(cherry picked from commit b576acff5e)
 2023-10-05 14:59:51 +02:00
Github Actions
380a5d2c9f Automatic update operator docs from VictoriaMetrics/operator@5da4bf6 (#5127) 2023-10-05 11:35:16 +02:00
Github Actions
e20f969ed3 Automatic update operator docs from VictoriaMetrics/operator@9fb79f4 (#5124) 2023-10-04 17:57:25 +02:00
Artem Navoiev
12b0e3e5cb add hugo front matter for operator docs (#5122) 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-10-04 16:28:23 +02:00
Github Actions
835393a59c Automatic update operator docs from VictoriaMetrics/operator@c7125bd (#5102) 2023-10-02 20:36:21 +02:00
Github Actions
d2bc7e2160 Automatic update operator docs from VictoriaMetrics/operator@83c07ed (#4970) 2023-09-08 23:33:42 +02:00
Github Actions
c12b24f2df Automatic update operator docs from VictoriaMetrics/operator@9c461d2 (#4968) 2023-09-07 13:04:49 +02:00
Github Actions
4eb42353bc Automatic update operator docs from VictoriaMetrics/operator@18e080e (#4921) 
Co-authored-by: Alexander Marshalov <_@marshalov.org>
 2023-08-30 15:21:05 +02:00
Github Actions
40b1f9611c Automatic update operator docs from VictoriaMetrics/operator@e00fe21 (#4891) 
(cherry picked from commit ef6468584c)
 2023-08-27 09:06:02 +02:00
Github Actions
336744a93e Automatic update operator docs from VictoriaMetrics/operator@ca27728 (#4802) 2023-08-11 04:58:55 -07:00
Github Actions
9d5f77cca0 Automatic update operator docs from VictoriaMetrics/operator@dd980c8 (#4751) 2023-08-11 03:13:14 -07:00
greynix
82a2d6aba5 docs/oprator/api.md: corrected broken links to Kubernetes documentation (#4433) 2023-07-06 16:47:44 -07:00
Alexander Marshalov
65f4590403 update generated docs for operator (#4267) 
Signed-off-by: Alexander Marshalov <_@marshalov.org>
 2023-05-09 22:06:28 -07:00
Timur Bakeyev
f21ea62ae1 Fix cut-n-paste error (#4079) 
It seems that VMServiceScrape description was c-n-p from vmselect one into all other resources.
 2023-04-06 00:44:29 -07:00
Timur Bakeyev
210216a1e2 Fix reference to the imagepullsecrets description (#4080) 
Looks like the original document has moved to the https://kubernetes.io/docs/concepts/containers/images/#referring-to-an-imagepullsecrets-on-a-pod.
Alternatively, it could be that https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ describes the meaning of the parameter in more detail.
 2023-04-05 19:57:22 -07:00
Alexander Marshalov
31005f4980 updated api doc for operator (#3972) 
Signed-off-by: Alexander Marshalov <_@marshalov.org>
 2023-03-17 16:17:17 -07:00
Nikolay
77e0e847a8 docs: updates operator api.md (#3922) 2023-03-08 01:12:16 -08:00
Artem Navoiev
efec0f150f fix operator docs hugo schema 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 17:00:14 -08:00
Artem Navoiev
8d238f1bc2 docs: prepare operator docs to migration 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 16:59:52 -08:00
Artem Navoiev
3991c977af docs: operator *.MD -> *.md 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 16:59:24 -08:00