12 Commits

Author	SHA1	Message	Date
Aliaksandr Valialkin	d5809f8e12	Revert "replaced global http refs with relative markdown ones (#6692)" ... This reverts commit 537266363a. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .	2024-07-25 12:48:12 +02:00
Andrii Chubatiuk	537266363a	replaced global http refs with relative markdown ones (#6692) ... ### Describe Your Changes Replaced global http links in docs with relative markdown ones ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).	2024-07-24 07:50:09 -07:00
Andrii Chubatiuk	ce4cc4cbb2	view documentation locally (#6677) ... ### Describe Your Changes - moved files from root to VictoriaMetrics folder to be able to mount operator docs and VictoriaMetrics docs independently - added ability to run website locally ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).	2024-07-24 01:00:31 -07:00
Aliaksandr Valialkin	b2e646280e	docs/goals.md: clarify that complicated CI/CD tasks make debugging harder	2024-07-19 08:50:58 +02:00
Aliaksandr Valialkin	c6e7fb688b	docs/goals.md: make clear that complication of CI/CD pipeline is bad ... CI/CD pipeline is usually hard to debug. So it is good to keep it as simple as possible.	2024-07-18 11:51:52 +02:00
Arkadii Yakovets	fabf0b928e	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 12:39:42 +02:00
Aliaksandr Valialkin	96bdeb3f10	docs/goals.md: clarify that the usability of the existing functionality must be improved the first	2024-06-27 09:55:11 +02:00
Aliaksandr Valialkin	4a3d1f4848	docs/goals.md: clarify that the listed goals are related to development and support, not sales and marketing	2024-06-26 19:11:02 +02:00
Aliaksandr Valialkin	3ccce17b94	docs/goals.md: heading fixes	2024-06-26 16:41:13 +02:00
Aliaksandr Valialkin	967c5a4be4	docs/goals.md: add VictoriaMetrics proverbs	2024-06-26 14:01:08 +02:00
Aliaksandr Valialkin	354d7733f6	docs/goals.md: add additional non-goals, which frequently become false goals according to the development history of VictoriaMetrics	2024-06-26 12:02:34 +02:00
Aliaksandr Valialkin	a632abf965	docs/goals.md: add VictoriaMetrics goals and non-goals page ... Everybody who works on VictoriaMetrics must be aware of these goals and non-goals	2024-06-25 18:00:09 +02:00