From d5f21f3f4b3371626eb1f40b0fca675dac32b19a Mon Sep 17 00:00:00 2001
From: dereksfoster99 <62961548+dereksfoster99@users.noreply.github.com>
Date: Thu, 25 Feb 2021 08:57:09 -0500
Subject: [PATCH] Native speaker edits. (#1088)
I made an effort to not change anything substantive.
---
docs/Quick-Start.md | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md
index df49809d34..e2f0f085cb 100644
--- a/docs/Quick-Start.md
+++ b/docs/Quick-Start.md
@@ -1,31 +1,31 @@
# Quick Start
-1. If you run Ubuntu, then just run `snap install victoriametrics` command in order to install and start VictoriaMetrics, then read [these docs](https://snapcraft.io/victoriametrics).
- Otherwise download the latest VictoriaMetrics release from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases),
- from [Docker hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/)
- or [build it from sources](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#how-to-build-from-sources).
+1. If you run Ubuntu please run the `snap install victoriametrics` command to install and start VictoriaMetrics. Then read [these docs](https://snapcraft.io/victoriametrics).
+ Otherwise you can download the latest VictoriaMetrics release from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases),
+ or [Docker hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/)
+ or [build it from sources](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#how-to-build-from-sources).
2. This step isn't needed if you run VictoriaMetrics via `snap install victoriametrics` as described above.
- Otherwise run the binary or Docker image with the desired command-line flags. Pass `-help` in order to see description for all the available flags
- and their default values. Default flag values should fit the majoirty of cases. The minimum required flags to configure are:
+ Otherwise, please run the binary or Docker image with your desired command-line flags. You can look at `-help` to see descriptions of all available flags
+ and their default values. The default flag values should fit the majority of cases. The minimum required flags that must be configured are:
- * `-storageDataPath` - path to directory where VictoriaMetrics stores all the data.
+ * `-storageDataPath` - the path to directory where VictoriaMetrics stores your data.
* `-retentionPeriod` - data retention.
- For instance:
+ For example:
`./victoria-metrics-prod -storageDataPath=/var/lib/victoria-metrics-data -retentionPeriod=3`
- See [these instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) in order to configure VictoriaMetrics as OS service.
- It is recommended setting up [VictoriaMetrics monitoring](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#monitoring).
+ Check [these instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) to configure VictoriaMetrics as an OS service.
+ We recommended setting up [VictoriaMetrics monitoring](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#monitoring).
-3. Configure [vmagent](https://victoriametrics.github.io/vmagent.html) or Prometheus to write data to VictoriaMetrics.
- It is recommended to use `vmagent` instead of Prometheus, since it is more resource efficient. If you still prefer Prometheus, then
+3. Configure either [vmagent](https://victoriametrics.github.io/vmagent.html) or Prometheus to write data to VictoriaMetrics.
+ We recommended using `vmagent` instead of Prometheus because it is more resource efficient. If you still prefer Prometheus
see [these instructions](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#prometheus-setup)
- for details on how to configure Prometheus.
+ for details on how it may be properly configured.
-4. Configure Grafana to query VictoriaMetrics instead of Prometheus.
- See [these instructions](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#grafana-setup).
+4. To configure Grafana to query VictoriaMetrics instead of Prometheus
+ please see [these instructions](https://victoriametrics.github.io/Single-server-VictoriaMetrics.html#grafana-setup).
There is also [cluster version](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster) and [SaaS playground](https://play.victoriametrics.com/signIn).