Skip to content

Commit

Permalink
Fix several typos in documentation (#4270)
Browse files Browse the repository at this point in the history
  • Loading branch information
Calinou authored and ktsaou committed Sep 23, 2018
1 parent fc1008b commit e540906
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 23 deletions.
11 changes: 5 additions & 6 deletions REDISTRIBUTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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/)
Expand Down Expand Up @@ -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)

8 changes: 4 additions & 4 deletions makeself/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# 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
$ ./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.

---
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion plugins.d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
24 changes: 12 additions & 12 deletions python.d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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.

---

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand All @@ -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

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit e540906

Please sign in to comment.