summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2018-09-23 22:50:20 +0200
committerCosta Tsaousis <costa@tsaousis.gr>2018-09-23 23:50:20 +0300
commite54090623ec06e06a29a0a1ad018e33129f19bf4 (patch)
treeeb69f9a7a2b351c8655ac2ee5dea054cd01a52f8
parentfc1008b7cc6d8fe6a5252bf0e7444b94d861ff81 (diff)
Fix several typos in documentation (#4270)
-rw-r--r--REDISTRIBUTED.md11
-rw-r--r--makeself/README.md8
-rw-r--r--plugins.d/README.md2
-rw-r--r--python.d/README.md24
4 files changed, 22 insertions, 23 deletions
diff --git a/REDISTRIBUTED.md b/REDISTRIBUTED.md
index 14fc0ceff5..ed30624fb0 100644
--- a/REDISTRIBUTED.md
+++ b/REDISTRIBUTED.md
@@ -4,16 +4,16 @@ Copyright 2016-2017, Costa Tsaousis.
Copyright 2017-2018, Netdata Inc.
Released under [GPL v3 or later](http://www.gnu.org/licenses/gpl-3.0.en.html).
-Netdata uses SPDX license tags to identify the license for it's files.
-Individual licenses referenced in the tags are available [on SPDX project site](http://spdx.org/licenses/).
+Netdata uses SPDX license tags to identify the license for its files.
+Individual licenses referenced in the tags are available on the [SPDX project site](http://spdx.org/licenses/).
---
## Re-distributed software
-Netdata re-distributes the following third party software.
+Netdata re-distributes the following third-party software.
We have decided to re-distribute all these, instead of using them
-through a CDN, to allow netdata to work in cases where internet
+through a CDN, to allow netdata to work in cases where Internet
connectivity is not available.
- [Dygraphs](http://dygraphs.com/)
@@ -28,7 +28,7 @@ connectivity is not available.
[MIT License](https://github.com/rendro/easy-pie-chart/blob/master/LICENSE)
-- [Guage.js](http://bernii.github.io/gauge.js/)
+- [Gauge.js](http://bernii.github.io/gauge.js/)
Copyright, Bernard Kobos
[MIT License](http://bernii.github.io/gauge.js/)
@@ -207,4 +207,3 @@ connectivity is not available.
Copyright 2014, 2015, 2016 Ori Livneh <ori@wikimedia.org>
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
-
diff --git a/makeself/README.md b/makeself/README.md
index de54eb349e..e7bb8612af 100644
--- a/makeself/README.md
+++ b/makeself/README.md
@@ -1,6 +1,6 @@
# netdata static binary build
-To build the static binary 64bit distribution package, run:
+To build the static binary 64-bit distribution package, run:
```bash
$ cd /path/to/netdata.git
@@ -8,12 +8,12 @@ $ ./makeself/build-x86_64-static.sh
```
The program will:
-
+
1. setup a new docker container with Alpine Linux
2. install the required alpine packages (the build environment, needed libraries, etc)
3. download and compile third party apps that are packaged with netdata (`bash`, `curl`, etc)
4. compile netdata
-
+
Once finished, a file named `netdata-vX.X.X-gGITHASH-x86_64-DATE-TIME.run` will be created in the current directory. This is the netdata binary package that can be run to install netdata on any other computer.
---
@@ -43,4 +43,4 @@ If netdata crashes, `valgrind` will print a stack trace of the issue. Open a git
To stop netdata while it runs under `valgrind`, press Control-C on the console.
-> If you ommit the parameter `--undef-value-errors=no` to valgrind, you will get hundreds of errors about conditional jumps that depend on unitialized values. This is normal. Valgrind has heuristics to prevent it from printing such errors for system libraries, but for the static netdata binary, all the required libraries are built into netdata. So, valgrind cannot appply its heuristics and prints them.
+> If you omit the parameter `--undef-value-errors=no` to valgrind, you will get hundreds of errors about conditional jumps that depend on uninitialized values. This is normal. Valgrind has heuristics to prevent it from printing such errors for system libraries, but for the static netdata binary, all the required libraries are built into netdata. So, valgrind cannot appply its heuristics and prints them.
diff --git a/plugins.d/README.md b/plugins.d/README.md
index 35b9a2d995..d2e2ed4c2b 100644
--- a/plugins.d/README.md
+++ b/plugins.d/README.md
@@ -182,7 +182,7 @@ data collection is defined as a series of `BEGIN` -> `SET` -> `END` lines
is the number of microseconds since the last update of the chart,
it is optional.
- Under heavy system load, the system may have some latency transfering
+ Under heavy system load, the system may have some latency transferring
data from the plugins to netdata via the pipe. This number improves
accuracy significantly, since the plugin is able to calculate the
duration between its iterations better than netdata.
diff --git a/python.d/README.md b/python.d/README.md
index 2262016157..d6ab2123d6 100644
--- a/python.d/README.md
+++ b/python.d/README.md
@@ -43,7 +43,7 @@ The following python.d modules are supported:
# apache
-This module will monitor one or more apache servers depending on configuration.
+This module will monitor one or more Apache servers depending on configuration.
**Requirements:**
* apache with enabled `mod_status`
@@ -127,7 +127,7 @@ If no configuration is given, module will attempt to read log file at `/var/log/
# beanstalk
-Module provides server and tube level statistics:
+Module provides server and tube-level statistics:
**Requirements:**
* `python-beanstalkc`
@@ -464,12 +464,12 @@ each state.
---
# dns_query_time
-This module provides dns query time statistics.
+This module provides DNS query time statistics.
**Requirement:**
* `python-dnspython` package
-It produces one aggregate chart or one chart per dns server, showing the query time.
+It produces one aggregate chart or one chart per DNS server, showing the query time.
---
@@ -557,12 +557,12 @@ Following charts are drawn:
# dovecot
-This module provides statistics information from dovecot server.
+This module provides statistics information from Dovecot server.
Statistics are taken from dovecot socket by executing `EXPORT global` command.
More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
**Requirement:**
-Dovecot unix socket with R/W permissions for user netdata or dovecot with configured TCP/IP socket.
+Dovecot UNIX socket with R/W permissions for user netdata or Dovecot with configured TCP/IP socket.
Module gives information with following charts:
@@ -602,7 +602,7 @@ Module gives information with following charts:
10. **hits** - number of cache hits
* hits
-11. **attempts** - authorization attemts
+11. **attempts** - authorization attempts
* success
* failure
@@ -631,7 +631,7 @@ If no configuration is given, module will attempt to connect to dovecot using un
# elasticsearch
-Module monitor elasticsearch performance and health metrics
+This module monitors Elasticsearch performance and health metrics.
It produces:
@@ -646,7 +646,7 @@ It produces:
* Indexing and flushing latency
3. **Memory usage and garbace collection** charts:
- * JVM heap currently in use, commited
+ * JVM heap currently in use, committed
* Count of garbage collections
* Time spent on garbage collections
@@ -1089,7 +1089,7 @@ If no configuration is given, module will use "/tmp/lshttpd/".
# logind
-THis module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
+This module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
It provides the following charts:
@@ -1997,7 +1997,7 @@ Following charts are drawn:
* cache
8. **Transactions on db** transactions/s
- * commited
+ * committed
* rolled back
9. **Tuples written to db** writes/s
@@ -2796,7 +2796,7 @@ It produces following charts:
9. **IP protocols** requests/s (requests per ip protocol version)
-10. **Curent Poll Unique Client IPs** unique ips/s (unique client IPs per data collection iteration)
+10. **Current Poll Unique Client IPs** unique ips/s (unique client IPs per data collection iteration)
11. **All Time Unique Client IPs** unique ips/s (unique client IPs since the last restart of netdata)