mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
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>
This commit is contained in:
Andrii Chubatiuk
GitHub
parent
53919327b2
commit
58e667c895
33 changed files with 125 additions and 6611 deletions
31
Makefile
31
Makefile
|
|
@ -513,34 +513,3 @@ install-wwhrd:
|
|||
|
||||
check-licenses: install-wwhrd
|
||||
wwhrd check -f .wwhrd.yml
|
||||
|
||||
copy-docs:
|
||||
# The 'printf' function is used instead of 'echo' or 'echo -e' to handle line breaks (e.g. '\n') in the same way on different operating systems (MacOS/Ubuntu Linux/Arch Linux) and their shells (bash/sh/zsh/fish).
|
||||
# For details, see https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4548#issue-1782796419 and https://stackoverflow.com/questions/8467424/echo-newline-in-bash-prints-literal-n
|
||||
echo "---" > ${DST}
|
||||
@if [ ${ORDER} -ne 0 ]; then \
|
||||
echo "sort: ${ORDER}" >> ${DST}; \
|
||||
echo "weight: ${ORDER}" >> ${DST}; \
|
||||
printf "menu:\n docs:\n parent: 'victoriametrics'\n weight: ${ORDER}\n" >> ${DST}; \
|
||||
fi
|
||||
|
||||
echo "title: ${TITLE}" >> ${DST}
|
||||
@if [ ${OLD_URL} ]; then \
|
||||
printf "aliases:\n - ${OLD_URL}\n" >> ${DST}; \
|
||||
fi
|
||||
echo "---" >> ${DST}
|
||||
cat ${SRC} >> ${DST}
|
||||
sed -i='.tmp' 's/<img src=\"docs\//<img src=\"/' ${DST}
|
||||
sed -i='.tmp' 's/<source srcset=\"docs\//<source srcset=\"/' ${DST}
|
||||
rm -rf docs/*.tmp
|
||||
|
||||
# Copies docs for all components and adds the order/weight tag, title, menu position and alias with the backward compatible link for the old site.
|
||||
# For ORDER=0 it adds no order tag/weight tag.
|
||||
# FOR OLD_URL - relative link, used for backward compatibility with the link from documentation based on GitHub pages (old one)
|
||||
# FOR OLD_URL='' it adds no alias, it should be empty for every new page, don't change it for already existing links.
|
||||
# Images starting with <img src="docs/ are replaced with <img src="
|
||||
# Cluster docs are supposed to be ordered as 2nd.
|
||||
# The rest of docs is ordered manually.
|
||||
docs-sync:
|
||||
SRC=README.md DST=docs/README.md OLD_URL='' ORDER=0 TITLE=VictoriaMetrics $(MAKE) copy-docs
|
||||
SRC=README.md DST=docs/Single-server-VictoriaMetrics.md OLD_URL='/Single-server-VictoriaMetrics.html' TITLE=VictoriaMetrics ORDER=1 $(MAKE) copy-docs
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
sort: 32
|
||||
weight: 32
|
||||
title: VictoriaMetrics best practices
|
||||
title: Best practices
|
||||
menu:
|
||||
docs:
|
||||
identifier: vm-best-practices
|
||||
parent: 'victoriametrics'
|
||||
weight: 32
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ weight: 100
|
|||
title: CHANGELOG
|
||||
menu:
|
||||
docs:
|
||||
identifier: vm-changelog
|
||||
parent: victoriametrics
|
||||
weight: 100
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
sort: 101
|
||||
weight: 101
|
||||
title: CHANGELOG for the year 2020
|
||||
sort: 6
|
||||
weight: 6
|
||||
title: Year 2020
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
weight: 101
|
||||
identifier: vm-changelog-2020
|
||||
parent: vm-changelog
|
||||
weight: 6
|
||||
aliases:
|
||||
- /CHANGELOG_2020.html
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
sort: 102
|
||||
weight: 102
|
||||
title: CHANGELOG for the year 2021
|
||||
sort: 5
|
||||
weight: 5
|
||||
title: Year 2021
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
weight: 102
|
||||
identifier: vm-changelog-2021
|
||||
parent: vm-changelog
|
||||
weight: 5
|
||||
aliases:
|
||||
- /CHANGELOG_2021.html
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
sort: 103
|
||||
weight: 103
|
||||
title: CHANGELOG for the year 2022
|
||||
sort: 4
|
||||
weight: 4
|
||||
title: Year 2022
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
weight: 103
|
||||
identifier: vm-changelog-2022
|
||||
parent: vm-changelog
|
||||
weight: 4
|
||||
aliases:
|
||||
- /CHANGELOG_2022.html
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
sort: 104
|
||||
weight: 104
|
||||
title: CHANGELOG for the year 2023
|
||||
sort: 3
|
||||
weight: 3
|
||||
title: Year 2023
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
weight: 104
|
||||
identifier: vm-changelog-2023
|
||||
parent: vm-changelog
|
||||
weight: 3
|
||||
aliases:
|
||||
- /CHANGELOG_2023.html
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
sort: 400
|
||||
weight: 400
|
||||
title: Contributing to VictoriaMetrics
|
||||
title: Contributing
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
identifier: vm-contributing
|
||||
parent: victoriametrics
|
||||
weight: 400
|
||||
aliases:
|
||||
- /CONTRIBUTING.html
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ sort: 2
|
|||
weight: 2
|
||||
menu:
|
||||
docs:
|
||||
identifier: vm-cluster-version
|
||||
parent: 'victoriametrics'
|
||||
weight: 2
|
||||
title: Cluster version
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
sort: 31
|
||||
weight: 31
|
||||
title: VictoriaMetrics Cluster Per Tenant Statistic
|
||||
title: Cluster Per Tenant Statistic
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
identifier: vm-cluster-per-tenant-statistic
|
||||
parent: victoriametrics
|
||||
weight: 31
|
||||
aliases:
|
||||
- /PerTenantStatistic.html
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@ weight: 22
|
|||
title: Quick start
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
identifier: vm-quick-start
|
||||
parent: victoriametrics
|
||||
weight: 22
|
||||
aliases:
|
||||
- /Quick-Start.html
|
||||
|
|
|
|||
|
|
@ -6,12 +6,6 @@
|
|||
[](https://github.com/VictoriaMetrics/VictoriaMetrics/actions)
|
||||
[](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics)
|
||||
|
||||
<picture>
|
||||
<source srcset="/logo_white.webp" media="(prefers-color-scheme: dark)">
|
||||
<source srcset="/logo.webp" media="(prefers-color-scheme: light)">
|
||||
<img src="/logo.webp" width="300" alt="VictoriaMetrics logo">
|
||||
</picture>
|
||||
|
||||
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.
|
||||
See [case studies for VictoriaMetrics](https://docs.victoriametrics.com/casestudies/).
|
||||
|
||||
|
|
@ -498,7 +492,7 @@ via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit
|
|||
DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL`
|
||||
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
|
||||
|
||||
|
||||
|
||||
|
||||
To configure DataDog agent via ENV variable add the following prefix:
|
||||
|
||||
|
|
@ -525,7 +519,7 @@ pick [single-node or cluster URL](https://docs.victoriametrics.com/url-examples/
|
|||
DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics
|
||||
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
|
||||
|
||||
|
||||
|
||||
|
||||
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
|
||||
|
||||
|
|
@ -2654,15 +2648,9 @@ and gets automatically updated once changes are merged to [master](https://githu
|
|||
To update the documentation follow the steps below:
|
||||
- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)
|
||||
VictoriaMetrics repo and apply changes to the docs:
|
||||
- To update [the main page](https://docs.victoriametrics.com/) modify [this file](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md).
|
||||
- To update [the main page](https://docs.victoriametrics.com/) modify [this file](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/README.md).
|
||||
- To update other pages, apply changes to the corresponding file in [docs folder](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs).
|
||||
- If your changes contain an image then see [images in documentation](https://docs.victoriametrics.com/#images-in-documentation).
|
||||
- Once changes are made, execute the command below to finalize and sync the changes:
|
||||
|
||||
```sh
|
||||
make docs-sync
|
||||
```
|
||||
|
||||
- Create [a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||
with proposed changes and wait for it to be merged.
|
||||
|
||||
|
|
@ -2675,7 +2663,7 @@ Requirements for changes to docs:
|
|||
- Prefer improving the existing docs instead of adding new ones.
|
||||
- Use absolute links. This simplifies moving docs between different files.
|
||||
|
||||
Priodically run `make spellcheck` - this command detects spelling errors at `docs/` folder. Please fix the found spelling errors
|
||||
Periodically run `make spellcheck` - this command detects spelling errors at `docs/` folder. Please fix the found spelling errors
|
||||
and commit the fixes in a separate commit.
|
||||
|
||||
### Images in documentation
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
File diff suppressed because it is too large
Load diff
|
|
@ -4,7 +4,8 @@ weight: 1
|
|||
title: Quick Start
|
||||
menu:
|
||||
docs:
|
||||
parent: "victorialogs"
|
||||
parent: victorialogs
|
||||
identifier: vl-quick-start
|
||||
weight: 1
|
||||
title: Quick Start
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@ weight: 2
|
|||
title: Key concepts
|
||||
menu:
|
||||
docs:
|
||||
parent: "victorialogs"
|
||||
identifier: vl-key-concepts
|
||||
parent: victorialogs
|
||||
weight: 2
|
||||
title: Key concepts
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
sort: 99
|
||||
weight: 99
|
||||
title: VictoriaMetrics Enterprise
|
||||
title: Enterprise
|
||||
menu:
|
||||
docs:
|
||||
identifier: vm-enterprise
|
||||
parent: 'victoriametrics'
|
||||
weight: 99
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
sort: 500
|
||||
weight: 500
|
||||
title: VictoriaMetrics development goals
|
||||
title: Development goals
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
1. [K8s monitoring via VM Single](k8s-monitoring-via-vm-single.html)
|
||||
1. [K8s monitoring via VM Cluster](k8s-monitoring-via-vm-cluster.html)
|
||||
1. [HA monitoring setup in K8s via VM Cluster](k8s-ha-monitoring-via-vm-cluster.html)
|
||||
1. [Getting started with VM Operator](getting-started-with-vm-operator.html)
|
||||
1. [Multi Retention Setup within VictoriaMetrics Cluster](guide-vmcluster-multiple-retention-setup.html)
|
||||
1. [Migrate from InfluxDB to VictoriaMetrics](migrate-from-influx.html)
|
||||
1. [Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring](multi-regional-setup-dedicated-regions.html)
|
||||
1. [How to delete or replace metrics in VictoriaMetrics](guide-delete-or-replace-metrics.html)
|
||||
1. [How to monitor kubernetes cluster using VictoriaMetrics Cloud](/victoriametrics-cloud/how-to-monitor-k8s.html)
|
||||
1. [How to configure vmgateway for multi-tenant access using Grafana and OpenID Connect](grafana-vmgateway-openid-configuration.html)
|
||||
1. [How to setup vmanomaly together with vmalert](/anomaly-detection/guides/guide-vmanomaly-vmalert/README.md)
|
||||
|
|
@ -3,3 +3,4 @@ weight: 0
|
|||
title: Guides
|
||||
disableToc: true
|
||||
---
|
||||
{{% section %}}
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@ weight: 34
|
|||
title: Key concepts
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
identifier: vm-key-concepts
|
||||
parent: victoriametrics
|
||||
weight: 34
|
||||
aliases:
|
||||
- /keyConcepts.html
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
sort: 33
|
||||
weight: 33
|
||||
title: VictoriaMetrics API examples
|
||||
title: API examples
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
weight: 33
|
||||
identifier: vm-api-examples
|
||||
|
||||
aliases:
|
||||
- /url-examples.html
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 3
|
|||
weight: 3
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 3
|
||||
title: vmagent
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 12
|
|||
weight: 12
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 12
|
||||
title: vmalert-tool
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 4
|
|||
weight: 4
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 4
|
||||
title: vmalert
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 5
|
|||
weight: 5
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 5
|
||||
title: vmauth
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 6
|
|||
weight: 6
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 6
|
||||
title: vmbackup
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 10
|
|||
weight: 10
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 10
|
||||
title: vmbackupmanager
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 8
|
|||
weight: 8
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 8
|
||||
title: vmctl
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 9
|
|||
weight: 9
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 9
|
||||
title: vmgateway
|
||||
aliases:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ sort: 7
|
|||
weight: 7
|
||||
menu:
|
||||
docs:
|
||||
parent: 'victoriametrics'
|
||||
parent: victoriametrics
|
||||
weight: 7
|
||||
title: vmrestore
|
||||
aliases:
|
||||
|
|
|
|||
Loading…
Reference in a new issue