From f6529f932af84def1bf8d684a755b1d567617612 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Thu, 25 Mar 2021 17:14:38 +0200 Subject: [PATCH] docs: add a link to the repository from build instruction for all the VictoriaMetrics components --- README.md | 10 +++++----- app/vmalert/README.md | 8 ++++---- app/vmauth/README.md | 4 ++-- app/vmbackup/README.md | 4 ++-- app/vmctl/README.md | 8 ++++---- app/vmrestore/README.md | 4 ++-- docs/Single-server-VictoriaMetrics.md | 10 +++++----- docs/vmalert.md | 8 ++++---- docs/vmauth.md | 4 ++-- docs/vmbackup.md | 4 ++-- docs/vmctl.md | 8 ++++---- docs/vmrestore.md | 4 ++-- 12 files changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 1804fa2f7..21fb2698f 100644 --- a/README.md +++ b/README.md @@ -659,13 +659,13 @@ to your needs or when testing bugfixes. ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics` from the root folder of the repository. +2. Run `make victoria-metrics` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make victoria-metrics-prod` from the root folder of the repository. +2. Run `make victoria-metrics-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-prod` binary and puts it into the `bin` folder. ### ARM build @@ -675,13 +675,13 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b ### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics-arm` or `make victoria-metrics-arm64` from the root folder of the repository. +2. Run `make victoria-metrics-arm` or `make victoria-metrics-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-arm` or `victoria-metrics-arm64` binary respectively and puts it into the `bin` folder. ### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make victoria-metrics-arm-prod` or `make victoria-metrics-arm64-prod` from the root folder of the repository. +2. Run `make victoria-metrics-arm-prod` or `make victoria-metrics-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-arm-prod` or `victoria-metrics-arm64-prod` binary respectively and puts it into the `bin` folder. ### Pure Go build (CGO_ENABLED=0) @@ -689,7 +689,7 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b `Pure Go` mode builds only Go code without [cgo](https://golang.org/cmd/cgo/) dependencies. 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics-pure` from the root folder of the repository. +2. Run `make victoria-metrics-pure` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-pure` binary and puts it into the `bin` folder. ### Building docker images diff --git a/app/vmalert/README.md b/app/vmalert/README.md index ea3655f9d..12e4f6179 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -391,13 +391,13 @@ It is recommended using #### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmalert` from the root folder of the repository. +2. Run `make vmalert` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert` binary and puts it into the `bin` folder. #### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmalert-prod` from the root folder of the repository. +2. Run `make vmalert-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-prod` binary and puts it into the `bin` folder. @@ -408,11 +408,11 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b #### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of the repository. +2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-arm` or `vmalert-arm64` binary respectively and puts it into the `bin` folder. #### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of the repository. +2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-arm-prod` or `vmalert-arm64-prod` binary respectively and puts it into the `bin` folder. diff --git a/app/vmauth/README.md b/app/vmauth/README.md index 4baa2b9e8..e93cc42d2 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -111,13 +111,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmauth` from the root folder of the repository. +2. Run `make vmauth` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmauth` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmauth-prod` from the root folder of the repository. +2. Run `make vmauth-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmauth-prod` binary and puts it into the `bin` folder. ### Building docker images diff --git a/app/vmbackup/README.md b/app/vmbackup/README.md index d471847a7..2cf5fe288 100644 --- a/app/vmbackup/README.md +++ b/app/vmbackup/README.md @@ -236,13 +236,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmbackup` from the root folder of the repository. +2. Run `make vmbackup` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmbackup` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmbackup-prod` from the root folder of the repository. +2. Run `make vmbackup-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmbackup-prod` binary and puts it into the `bin` folder. ### Building docker images diff --git a/app/vmctl/README.md b/app/vmctl/README.md index 8a53d590a..313a48ec6 100644 --- a/app/vmctl/README.md +++ b/app/vmctl/README.md @@ -49,13 +49,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmctl` from the root folder of the repository. +2. Run `make vmctl` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmctl-prod` from the root folder of the repository. +2. Run `make vmctl-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-prod` binary and puts it into the `bin` folder. ### Building docker images @@ -78,13 +78,13 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b #### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmctl-arm` or `make vmctl-arm64` from the root folder of the repository. +2. Run `make vmctl-arm` or `make vmctl-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-arm` or `vmctl-arm64` binary respectively and puts it into the `bin` folder. #### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmctl-arm-prod` or `make vmctl-arm64-prod` from the root folder of the repository. +2. Run `make vmctl-arm-prod` or `make vmctl-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-arm-prod` or `vmctl-arm64-prod` binary respectively and puts it into the `bin` folder. diff --git a/app/vmrestore/README.md b/app/vmrestore/README.md index 3fa55905d..0b044ad2a 100644 --- a/app/vmrestore/README.md +++ b/app/vmrestore/README.md @@ -132,13 +132,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmrestore` from the root folder of the repository. +2. Run `make vmrestore` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmrestore` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmrestore-prod` from the root folder of the repository. +2. Run `make vmrestore-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmrestore-prod` binary and puts it into the `bin` folder. ### Building docker images diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 1804fa2f7..21fb2698f 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -659,13 +659,13 @@ to your needs or when testing bugfixes. ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics` from the root folder of the repository. +2. Run `make victoria-metrics` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make victoria-metrics-prod` from the root folder of the repository. +2. Run `make victoria-metrics-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-prod` binary and puts it into the `bin` folder. ### ARM build @@ -675,13 +675,13 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b ### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics-arm` or `make victoria-metrics-arm64` from the root folder of the repository. +2. Run `make victoria-metrics-arm` or `make victoria-metrics-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-arm` or `victoria-metrics-arm64` binary respectively and puts it into the `bin` folder. ### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make victoria-metrics-arm-prod` or `make victoria-metrics-arm64-prod` from the root folder of the repository. +2. Run `make victoria-metrics-arm-prod` or `make victoria-metrics-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-arm-prod` or `victoria-metrics-arm64-prod` binary respectively and puts it into the `bin` folder. ### Pure Go build (CGO_ENABLED=0) @@ -689,7 +689,7 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b `Pure Go` mode builds only Go code without [cgo](https://golang.org/cmd/cgo/) dependencies. 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make victoria-metrics-pure` from the root folder of the repository. +2. Run `make victoria-metrics-pure` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `victoria-metrics-pure` binary and puts it into the `bin` folder. ### Building docker images diff --git a/docs/vmalert.md b/docs/vmalert.md index ea3655f9d..12e4f6179 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -391,13 +391,13 @@ It is recommended using #### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmalert` from the root folder of the repository. +2. Run `make vmalert` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert` binary and puts it into the `bin` folder. #### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmalert-prod` from the root folder of the repository. +2. Run `make vmalert-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-prod` binary and puts it into the `bin` folder. @@ -408,11 +408,11 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b #### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of the repository. +2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-arm` or `vmalert-arm64` binary respectively and puts it into the `bin` folder. #### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of the repository. +2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmalert-arm-prod` or `vmalert-arm64-prod` binary respectively and puts it into the `bin` folder. diff --git a/docs/vmauth.md b/docs/vmauth.md index 4baa2b9e8..e93cc42d2 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -111,13 +111,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmauth` from the root folder of the repository. +2. Run `make vmauth` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmauth` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmauth-prod` from the root folder of the repository. +2. Run `make vmauth-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmauth-prod` binary and puts it into the `bin` folder. ### Building docker images diff --git a/docs/vmbackup.md b/docs/vmbackup.md index d471847a7..2cf5fe288 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -236,13 +236,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmbackup` from the root folder of the repository. +2. Run `make vmbackup` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmbackup` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmbackup-prod` from the root folder of the repository. +2. Run `make vmbackup-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmbackup-prod` binary and puts it into the `bin` folder. ### Building docker images diff --git a/docs/vmctl.md b/docs/vmctl.md index 8a53d590a..313a48ec6 100644 --- a/docs/vmctl.md +++ b/docs/vmctl.md @@ -49,13 +49,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmctl` from the root folder of the repository. +2. Run `make vmctl` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmctl-prod` from the root folder of the repository. +2. Run `make vmctl-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-prod` binary and puts it into the `bin` folder. ### Building docker images @@ -78,13 +78,13 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b #### Development ARM build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmctl-arm` or `make vmctl-arm64` from the root folder of the repository. +2. Run `make vmctl-arm` or `make vmctl-arm64` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-arm` or `vmctl-arm64` binary respectively and puts it into the `bin` folder. #### Production ARM build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmctl-arm-prod` or `make vmctl-arm64-prod` from the root folder of the repository. +2. Run `make vmctl-arm-prod` or `make vmctl-arm64-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmctl-arm-prod` or `vmctl-arm64-prod` binary respectively and puts it into the `bin` folder. diff --git a/docs/vmrestore.md b/docs/vmrestore.md index 3fa55905d..0b044ad2a 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -132,13 +132,13 @@ It is recommended using [binary releases](https://github.com/VictoriaMetrics/Vic ### Development build 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.14. -2. Run `make vmrestore` from the root folder of the repository. +2. Run `make vmrestore` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmrestore` binary and puts it into the `bin` folder. ### Production build 1. [Install docker](https://docs.docker.com/install/). -2. Run `make vmrestore-prod` from the root folder of the repository. +2. Run `make vmrestore-prod` from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics). It builds `vmrestore-prod` binary and puts it into the `bin` folder. ### Building docker images