Fix several typos in documentation (#4270)
Hugo Locurcio committed
Sep 23, 2018 at 22:50 UTC
e54090623ec06e06a29a0a1ad018e33129f19bf4
4 files changed
+22
-23
REDISTRIBUTED.md
+5
-6
@@ -4,16 +4,16 @@ Copyright 2016-2017, Costa Tsaousis.
4
Copyright 2017-2018, Netdata Inc.
5
Released under [GPL v3 or later](http://www.gnu.org/licenses/gpl-3.0.en.html).
6
7
-Netdata uses SPDX license tags to identify the license for it's files.
8
-Individual licenses referenced in the tags are available [on SPDX project site](http://spdx.org/licenses/).
7
+Netdata uses SPDX license tags to identify the license for its files.
8
+Individual licenses referenced in the tags are available on the [SPDX project site](http://spdx.org/licenses/).
9
10
---
11
12
## Re-distributed software
13
14
-Netdata re-distributes the following third party software.
14
+Netdata re-distributes the following third-party software.
15
We have decided to re-distribute all these, instead of using them
16
-through a CDN, to allow netdata to work in cases where internet
16
+through a CDN, to allow netdata to work in cases where Internet
17
connectivity is not available.
18
19
- [Dygraphs](http://dygraphs.com/)
@@ -28,7 +28,7 @@ connectivity is not available.
28
[MIT License](https://github.com/rendro/easy-pie-chart/blob/master/LICENSE)
29
30
31
-- [Guage.js](http://bernii.github.io/gauge.js/)
31
+- [Gauge.js](http://bernii.github.io/gauge.js/)
32
33
Copyright, Bernard Kobos
34
[MIT License](http://bernii.github.io/gauge.js/)
@@ -207,4 +207,3 @@ connectivity is not available.
207
208
Copyright 2014, 2015, 2016 Ori Livneh <ori@wikimedia.org>
209
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
210
-
makeself/README.md
+4
-4
@@ -1,6 +1,6 @@
1
# netdata static binary build
2
3
-To build the static binary 64bit distribution package, run:
3
+To build the static binary 64-bit distribution package, run:
4
5
```bash
6
$ cd /path/to/netdata.git
@@ -8,12 +8,12 @@ $ ./makeself/build-x86_64-static.sh
8
```
9
10
The program will:
11
-
11
+
12
1. setup a new docker container with Alpine Linux
13
2. install the required alpine packages (the build environment, needed libraries, etc)
14
3. download and compile third party apps that are packaged with netdata (`bash`, `curl`, etc)
15
4. compile netdata
16
-
16
+
17
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.
18
19
---
@@ -43,4 +43,4 @@ If netdata crashes, `valgrind` will print a stack trace of the issue. Open a git
43
44
To stop netdata while it runs under `valgrind`, press Control-C on the console.
45
46
-> 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.
46
+> 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.
plugins.d/README.md
+1
-1
@@ -182,7 +182,7 @@ data collection is defined as a series of `BEGIN` -> `SET` -> `END` lines
182
is the number of microseconds since the last update of the chart,
183
it is optional.
184
185
- Under heavy system load, the system may have some latency transfering
185
+ Under heavy system load, the system may have some latency transferring
186
data from the plugins to netdata via the pipe. This number improves
187
accuracy significantly, since the plugin is able to calculate the
188
duration between its iterations better than netdata.
python.d/README.md
+12
-12
@@ -43,7 +43,7 @@ The following python.d modules are supported:
43
44
# apache
45
46
-This module will monitor one or more apache servers depending on configuration.
46
+This module will monitor one or more Apache servers depending on configuration.
47
48
**Requirements:**
49
* apache with enabled `mod_status`
@@ -127,7 +127,7 @@ If no configuration is given, module will attempt to read log file at `/var/log/
127
128
# beanstalk
129
130
-Module provides server and tube level statistics:
130
+Module provides server and tube-level statistics:
131
132
**Requirements:**
133
* `python-beanstalkc`
@@ -464,12 +464,12 @@ each state.
464
---
465
# dns_query_time
466
467
-This module provides dns query time statistics.
467
+This module provides DNS query time statistics.
468
469
**Requirement:**
470
* `python-dnspython` package
471
472
-It produces one aggregate chart or one chart per dns server, showing the query time.
472
+It produces one aggregate chart or one chart per DNS server, showing the query time.
473
474
---
475
@@ -557,12 +557,12 @@ Following charts are drawn:
557
558
# dovecot
559
560
-This module provides statistics information from dovecot server.
560
+This module provides statistics information from Dovecot server.
561
Statistics are taken from dovecot socket by executing `EXPORT global` command.
562
More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
563
564
**Requirement:**
565
-Dovecot unix socket with R/W permissions for user netdata or dovecot with configured TCP/IP socket.
565
+Dovecot UNIX socket with R/W permissions for user netdata or Dovecot with configured TCP/IP socket.
566
567
Module gives information with following charts:
568
@@ -602,7 +602,7 @@ Module gives information with following charts:
602
10. **hits** - number of cache hits
603
* hits
604
605
-11. **attempts** - authorization attemts
605
+11. **attempts** - authorization attempts
606
* success
607
* failure
608
@@ -631,7 +631,7 @@ If no configuration is given, module will attempt to connect to dovecot using un
631
632
# elasticsearch
633
634
-Module monitor elasticsearch performance and health metrics
634
+This module monitors Elasticsearch performance and health metrics.
635
636
It produces:
637
@@ -646,7 +646,7 @@ It produces:
646
* Indexing and flushing latency
647
648
3. **Memory usage and garbace collection** charts:
649
- * JVM heap currently in use, commited
649
+ * JVM heap currently in use, committed
650
* Count of garbage collections
651
* Time spent on garbage collections
652
@@ -1089,7 +1089,7 @@ If no configuration is given, module will use "/tmp/lshttpd/".
1089
1090
# logind
1091
1092
-THis module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
1092
+This module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
1093
1094
It provides the following charts:
1095
@@ -1997,7 +1997,7 @@ Following charts are drawn:
1997
* cache
1998
1999
8. **Transactions on db** transactions/s
2000
- * commited
2000
+ * committed
2001
* rolled back
2002
2003
9. **Tuples written to db** writes/s
@@ -2796,7 +2796,7 @@ It produces following charts:
2796
2797
9. **IP protocols** requests/s (requests per ip protocol version)
2798
2799
-10. **Curent Poll Unique Client IPs** unique ips/s (unique client IPs per data collection iteration)
2799
+10. **Current Poll Unique Client IPs** unique ips/s (unique client IPs per data collection iteration)
2800
2801
11. **All Time Unique Client IPs** unique ips/s (unique client IPs since the last restart of netdata)
2802