From 076799ae29f7233b7a4d376d218aa6143440acae Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 11 Jul 2022 21:23:19 +0300 Subject: [PATCH] docs: add links to https://docs.victoriametrics.com/CHANGELOG.html in relevant docs --- README.md | 20 +++++++++++++++++--- docs/Quick-Start.md | 4 +++- docs/README.md | 20 +++++++++++++++++--- docs/Single-server-VictoriaMetrics.md | 20 +++++++++++++++++--- 4 files changed, 54 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7241c3ccdd..5968a5f374 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,21 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). -Just download VictoriaMetrics and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). +Just download [the latest version of VictoriaMetrics](https://docs.victoriametrics.com/CHANGELOG.html) +and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). The cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). Learn more about [key concepts](https://docs.victoriametrics.com/keyConcepts.html) of VictoriaMetrics and follow the -[QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. +[quick start guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://victoriametrics.com/products/enterprise/). Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + ## Prominent features VictoriaMetrics has the following prominent features: @@ -110,12 +113,21 @@ The following command-line flags are used the most: Other flags have good enough default values, so set them only if you really need this. Pass `-help` to see [all the available flags with description and default values](#list-of-command-line-flags). -See how to [ingest data to VictoriaMetrics](#how-to-import-time-series-data), how to [query VictoriaMetrics via Grafana](#grafana-setup), how to [query VictoriaMetrics via Graphite API](#graphite-api-usage) and how to [handle alerts](#alerting). +The following docs may be useful during initial VictoriaMetrics setup: +* [How to set up scraping of Prometheus-compatible targets](https://docs.victoriametrics.com/#how-to-scrape-prometheus-exporters-such-as-node-exporter) +* [How to ingest data to VictoriaMetrics](#how-to-import-time-series-data) +* [How to set up Prometheus to write data to VictoriaMetrics](https://docs.victoriametrics.com/#prometheus-setup) +* [How to query VictoriaMetrics via Grafana](#grafana-setup) +* [How to query VictoriaMetrics via Graphite API](#graphite-api-usage) +* [How to handle alerts](#alerting) VictoriaMetrics accepts [Prometheus querying API requests](#prometheus-querying-api-usage) on port `8428` by default. It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics. +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + + ### Environment variables Each flag value can be set via environment variables according to these rules: @@ -228,6 +240,8 @@ Then build graphs and dashboards for the created datasource using [PromQL](https ## How to upgrade VictoriaMetrics +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. + It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 5ee27eac39..113bd0fbe2 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -30,6 +30,8 @@ Just download VictoriaMetrics and follow Then read [Prometheus setup](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#prometheus-setup) and [Grafana setup](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#grafana-setup) docs. +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](https://docs.victoriametrics.com/#how-to-upgrade-victoriametrics). + ### Starting VM-Single via Docker @@ -169,4 +171,4 @@ and [backups](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.htm To avoid excessive resource usage or performance degradation limits must be in place: * [Resource usage limits](https://docs.victoriametrics.com/FAQ.html#how-to-set-a-memory-limit-for-victoriametrics-components); -* [Cardinality limiter](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#cardinality-limiter). \ No newline at end of file +* [Cardinality limiter](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#cardinality-limiter). diff --git a/docs/README.md b/docs/README.md index 7241c3ccdd..5968a5f374 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,18 +15,21 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). -Just download VictoriaMetrics and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). +Just download [the latest version of VictoriaMetrics](https://docs.victoriametrics.com/CHANGELOG.html) +and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). The cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). Learn more about [key concepts](https://docs.victoriametrics.com/keyConcepts.html) of VictoriaMetrics and follow the -[QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. +[quick start guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://victoriametrics.com/products/enterprise/). Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + ## Prominent features VictoriaMetrics has the following prominent features: @@ -110,12 +113,21 @@ The following command-line flags are used the most: Other flags have good enough default values, so set them only if you really need this. Pass `-help` to see [all the available flags with description and default values](#list-of-command-line-flags). -See how to [ingest data to VictoriaMetrics](#how-to-import-time-series-data), how to [query VictoriaMetrics via Grafana](#grafana-setup), how to [query VictoriaMetrics via Graphite API](#graphite-api-usage) and how to [handle alerts](#alerting). +The following docs may be useful during initial VictoriaMetrics setup: +* [How to set up scraping of Prometheus-compatible targets](https://docs.victoriametrics.com/#how-to-scrape-prometheus-exporters-such-as-node-exporter) +* [How to ingest data to VictoriaMetrics](#how-to-import-time-series-data) +* [How to set up Prometheus to write data to VictoriaMetrics](https://docs.victoriametrics.com/#prometheus-setup) +* [How to query VictoriaMetrics via Grafana](#grafana-setup) +* [How to query VictoriaMetrics via Graphite API](#graphite-api-usage) +* [How to handle alerts](#alerting) VictoriaMetrics accepts [Prometheus querying API requests](#prometheus-querying-api-usage) on port `8428` by default. It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics. +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + + ### Environment variables Each flag value can be set via environment variables according to these rules: @@ -228,6 +240,8 @@ Then build graphs and dashboards for the created datasource using [PromQL](https ## How to upgrade VictoriaMetrics +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. + It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 2550decec4..debb269215 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -19,18 +19,21 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). -Just download VictoriaMetrics and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). +Just download [the latest version of VictoriaMetrics](https://docs.victoriametrics.com/CHANGELOG.html) +and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). The cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). Learn more about [key concepts](https://docs.victoriametrics.com/keyConcepts.html) of VictoriaMetrics and follow the -[QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. +[quick start guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://victoriametrics.com/products/enterprise/). Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + ## Prominent features VictoriaMetrics has the following prominent features: @@ -114,12 +117,21 @@ The following command-line flags are used the most: Other flags have good enough default values, so set them only if you really need this. Pass `-help` to see [all the available flags with description and default values](#list-of-command-line-flags). -See how to [ingest data to VictoriaMetrics](#how-to-import-time-series-data), how to [query VictoriaMetrics via Grafana](#grafana-setup), how to [query VictoriaMetrics via Graphite API](#graphite-api-usage) and how to [handle alerts](#alerting). +The following docs may be useful during initial VictoriaMetrics setup: +* [How to set up scraping of Prometheus-compatible targets](https://docs.victoriametrics.com/#how-to-scrape-prometheus-exporters-such-as-node-exporter) +* [How to ingest data to VictoriaMetrics](#how-to-import-time-series-data) +* [How to set up Prometheus to write data to VictoriaMetrics](https://docs.victoriametrics.com/#prometheus-setup) +* [How to query VictoriaMetrics via Grafana](#grafana-setup) +* [How to query VictoriaMetrics via Graphite API](#graphite-api-usage) +* [How to handle alerts](#alerting) VictoriaMetrics accepts [Prometheus querying API requests](#prometheus-querying-api-usage) on port `8428` by default. It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics. +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). + + ### Environment variables Each flag value can be set via environment variables according to these rules: @@ -232,6 +244,8 @@ Then build graphs and dashboards for the created datasource using [PromQL](https ## How to upgrade VictoriaMetrics +VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. + It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise.