Github Actions
015f0b0424
Automatic update operator docs from VictoriaMetrics/operator@64879fb ( #6831 )
...
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>
Signed-off-by: f41gh7 <nik@victoriametrics.com>
2024-08-16 16:32:25 +02:00
Github Actions
f41f5ef62e
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>
2024-07-08 01:29:18 -07:00
Github Actions
ad806b26fb
Automatic update operator docs from VictoriaMetrics/operator@0c311bb ( #6574 )
2024-07-04 10:05:45 +02:00
Aliaksandr Valialkin
10390a7dfc
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:43 +02:00
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
020d3f3d88
Automatic update operator docs from VictoriaMetrics/operator@310a860 ( #6449 )
2024-06-10 22:17:32 +02: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
c87ce86d96
Automatic update operator docs from VictoriaMetrics/operator@0829591 ( #6250 )
2024-05-10 10:57:10 +08:00
Github Actions
55c7dafb35
Automatic update operator docs from VictoriaMetrics/operator@2789953 ( #6237 )
2024-05-07 21:34:57 +02:00
Github Actions
134dcaef33
Automatic update operator docs from VictoriaMetrics/operator@6271553 ( #6233 )
2024-05-07 16:51:39 +02:00
Github Actions
301bd387d4
Automatic update operator docs from VictoriaMetrics/operator@e343a8e ( #6168 )
2024-04-23 12:12:35 +02:00
Github Actions
45f7e58d6c
Automatic update operator docs from VictoriaMetrics/operator@781dbba ( #6143 )
2024-04-18 12:03:41 +02:00
Github Actions
21b2b1bf19
Automatic update operator docs from VictoriaMetrics/operator@7f6c6d8 ( #6138 )
2024-04-18 10:22:02 +02:00
Github Actions
1cbaec73ad
Automatic update operator docs from VictoriaMetrics/operator@99fbc98 ( #6122 )
2024-04-17 09:34:47 +02:00
Github Actions
7db8ba41e7
Automatic update operator docs from VictoriaMetrics/operator@cf48a99 ( #6113 )
2024-04-16 09:54:29 +08:00
Github Actions
cba2f6dce1
Automatic update operator docs from VictoriaMetrics/operator@73a1996 ( #6100 )
2024-04-13 10:04:25 +08:00
Github Actions
a4945c0bf0
Automatic update operator docs from VictoriaMetrics/operator@17082f0 ( #6090 )
2024-04-11 09:15:04 +02:00
Github Actions
1263cab870
Automatic update operator docs from VictoriaMetrics/operator@ac29c88 ( #6022 )
2024-03-26 23:35:41 +08:00
Github Actions
f4d16919ee
Automatic update operator docs from VictoriaMetrics/operator@ae6e1b6 ( #5964 )
2024-03-13 23:12:51 +01:00
Github Actions
a1e9af3abe
Automatic update operator docs from VictoriaMetrics/operator@c8ff654 ( #5918 )
2024-03-04 17:09:14 +01:00
Github Actions
ca8a4cfa0d
Automatic update operator docs from VictoriaMetrics/operator@7e8f811 ( #5902 )
2024-02-29 17:53:01 +02:00
Github Actions
1217c1f2da
Automatic update operator docs from VictoriaMetrics/operator@9f1c910 ( #5895 )
2024-02-29 13:56:13 +02:00
Github Actions
fae801edd3
Automatic update operator docs from VictoriaMetrics/operator@0628def ( #5694 )
2024-01-26 10:21:52 +01:00
Github Actions
05c9a4d7ce
Automatic update operator docs from VictoriaMetrics/operator@1470569 ( #5668 )
2024-01-23 16:22:16 +01:00
Github Actions
93b8bf66aa
Automatic update operator docs from VictoriaMetrics/operator@fec3f9d ( #5381 )
2023-11-23 21:06:03 +02:00
Github Actions
0a6932acfe
Automatic update operator docs from VictoriaMetrics/operator@2c826bb ( #5188 )
2023-10-17 15:57:11 +02:00
Github Actions
7abdbbc8e2
Automatic update operator docs from VictoriaMetrics/operator@79298bf ( #5177 )
2023-10-16 10:45:46 +08:00
Aliaksandr Valialkin
3f5a41e35e
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-13 14:56:09 +02:00
Github Actions
b576acff5e
Automatic update operator docs from VictoriaMetrics/operator@26d1b3b ( #5130 )
2023-10-05 12:43:28 +02:00
Github Actions
590bd50df4
Automatic update operator docs from VictoriaMetrics/operator@5da4bf6 ( #5127 )
2023-10-04 18:51:53 +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
Github Actions
78dfbe1622
Automatic update operator docs from VictoriaMetrics/operator@83c07ed ( #4970 )
2023-09-07 15:09:28 +02:00
Github Actions
72d3063bef
Automatic update operator docs from VictoriaMetrics/operator@9c461d2 ( #4968 )
2023-09-07 12:26:02 +02:00
Github Actions
3222780707
Automatic update operator docs from VictoriaMetrics/operator@18e080e ( #4921 )
...
Co-authored-by: Alexander Marshalov <_@marshalov.org>
2023-08-30 15:09:18 +02:00
Github Actions
ef6468584c
Automatic update operator docs from VictoriaMetrics/operator@e00fe21 ( #4891 )
2023-08-25 15:49:00 +02:00
Github Actions
0a93abfeed
Automatic update operator docs from VictoriaMetrics/operator@ca27728 ( #4802 )
2023-08-10 10:38:19 +02:00
Github Actions
837445b81b
Automatic update operator docs from VictoriaMetrics/operator@dd980c8 ( #4751 )
2023-07-31 20:59:39 +02:00
greynix
36bc1bb8ff
docs/oprator/api.md: corrected broken links to Kubernetes documentation ( #4433 )
2023-06-12 12:07:56 +02:00
Alexander Marshalov
c0cb3e4f98
update generated docs for operator ( #4267 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-05-08 12:39:44 +02:00
Timur Bakeyev
37a7627254
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 11:02:12 +04:00
Timur Bakeyev
d87a700528
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:56:28 -07:00
Alexander Marshalov
57b00bafc9
updated api doc for operator ( #3972 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-03-17 10:42:30 +01:00
Nikolay
02f13d5681
docs: updates operator api.md ( #3922 )
2023-03-07 09:09:05 +01:00
Artem Navoiev
13a1a7f826
fix operator docs hugo schema
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 17:28:34 +01:00
Artem Navoiev
83c87f822a
docs: prepare operator docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 18:19:40 +02:00
Artem Navoiev
54aec2b1ba
docs: operator *.MD -> *.md
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 16:29:29 +01:00