13 Commits

Author	SHA1	Message	Date
Andrii Chubatiuk	56a6e680e3	docs: grouped changelog docs, removed old make commands, replaced docs in root README with official docs links (#6727) ... ### Describe Your Changes - replace docs in root README with a link to official documentation - remove old make commands for documentation - remove redundant "VictoriaMetrics" from document titles - merge changelog docs into a section - rm content of Single-server-VictoriaMetrics.md as it can be included from docs/README - add basic information to README in the root folder, so it will be useful for github users - rm `picture` tag from docs/README as it was needed for github only, we don't display VM logo at docs.victoriametrics.com - update `## documentation` section in docs/README to reflect the changes - rename DD pictures, as they now belong to docs/README Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit 58e667c895) Signed-off-by: hagen1778 <roman@victoriametrics.com>	2024-07-31 16:15:08 +02:00
Aliaksandr Valialkin	83d53dfb0d	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 14:40:53 +02:00
Andrii Chubatiuk	b8d80ddae5	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-25 13:26:51 +02:00
Andrii Chubatiuk	6b97044d8a	view documentation locally (#6677) ... - moved files from root to VictoriaMetrics folder to be able to mount operator docs and VictoriaMetrics docs independently - added ability to run website locally The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).	2024-07-25 12:27:05 +02:00
Aliaksandr Valialkin	3dd239fb87	docs/goals.md: clarify that complicated CI/CD tasks make debugging harder	2024-07-19 08:51:23 +02:00
Aliaksandr Valialkin	12393c64f7	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:52:24 +02:00
Arkadii Yakovets	8645b2cc8e	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> (cherry picked from commit fabf0b928e)	2024-07-11 12:40:24 +02:00
Aliaksandr Valialkin	0352d98d74	docs/goals.md: clarify that the usability of the existing functionality must be improved the first	2024-06-27 09:55:40 +02:00
Aliaksandr Valialkin	911891da95	docs/goals.md: clarify that the listed goals are related to development and support, not sales and marketing	2024-06-26 19:12:36 +02:00
Aliaksandr Valialkin	3a2c0b0a61	docs/goals.md: heading fixes	2024-06-26 16:41:21 +02:00
Aliaksandr Valialkin	d2be74b4a1	docs/goals.md: add VictoriaMetrics proverbs	2024-06-26 14:01:15 +02:00
Aliaksandr Valialkin	db5a5a4f6e	docs/goals.md: add additional non-goals, which frequently become false goals according to the development history of VictoriaMetrics	2024-06-26 12:03:28 +02:00
Aliaksandr Valialkin	2dfbc40563	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:55 +02:00