@cryptotaxi247 / netdata-1 / commits / 4964cfc9d

Put back the obsolete bash module readmes (#4742)

* Updated obsolete bash plugin READMEs * Final corrections

Chris Akritidis committed Nov 25, 2018 at 23:39 UTC 4964cfc9d9b00b983e7a700d18bc363c32d3f1de
17 files changed +66 -40
Makefile.am
+1
@@ -77,6 +77,7 @@ dist_noinst_DATA= \
77 docs/netdata-for-IoT.md \
78 docs/netdata-security.md \
79 docs/Why-Netdata.md \
80 + docs/GettingStarted.md \
81 docs/generator/themes/material/partials/footer.html \
82 installer/README.md \
83 installer/UNINSTALL.md \
collectors/charts.d.plugin/apache/README.md
+3 -3
@@ -1,10 +1,10 @@
1 +# Apache
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/apache) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5
6 ---
7
6 -# Apache Plugin (apache)
7 -
8 The `apache` collector visualizes key performance data for an apache web server.
9
10 ## Example netdata charts
collectors/charts.d.plugin/cpu_apps/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# cpu_apps
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE APPS.PLUGIN.
4 +> USE [APPS.PLUGIN](../../apps.plugin).
collectors/charts.d.plugin/cpufreq/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# cpufreq
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE THE [PROC PLUGIN](../../proc.plugin) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
collectors/charts.d.plugin/exim/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# exim
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/exim) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
collectors/charts.d.plugin/hddtemp/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -> THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
3 -
1 # hddtemp
2
3 +> THIS MODULE IS OBSOLETE.
4 +> USE [THE PYTHON ONE](../../python.d.plugin/hddtemp) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5 +
6 The plugin will collect temperatures from disks
7
8 It will create one chart with all active disks
collectors/charts.d.plugin/load_average/README.md
+2
@@ -1,2 +1,4 @@
1 +# load_average
2 +
3 > THIS MODULE IS OBSOLETE.
4 > THE NETDATA DAEMON COLLECTS LOAD AVERAGE BY ITSELF
collectors/charts.d.plugin/mem_apps/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# mem_apps
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE APPS.PLUGIN.
4 +> USE [APPS.PLUGIN](../../apps.plugin).
collectors/charts.d.plugin/mysql/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -> THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
3 -
1 # mysql
2
3 +> THIS MODULE IS OBSOLETE.
4 +> USE [THE PYTHON ONE](../../python.d.plugin/mysql) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5 +
6 The plugin will monitor one or more mysql servers
7
8 It will produce the following charts:
collectors/charts.d.plugin/nginx/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# nginx
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/nginx) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
collectors/charts.d.plugin/phpfpm/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# phpfm
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/phpfpm) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
collectors/charts.d.plugin/postfix/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -> THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
3 -
1 # postfix
2
3 +> THIS MODULE IS OBSOLETE.
4 +> USE [THE PYTHON ONE](../../python.d.plugin/postfix) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5 +
6 The plugin will collect the postfix queue size.
7
8 It will create two charts:
collectors/charts.d.plugin/sensors/README.md
+3 -2
@@ -1,9 +1,10 @@
1 +# sensors
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5
6 > Unlike the python one, this module can collect temperature on RPi.
7
6 -# sensors
8
9 The plugin will provide charts for all configured system sensors
10
collectors/charts.d.plugin/squid/README.md
+3 -4
@@ -1,9 +1,8 @@
1 -> THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
3 -
4 -
1 # squid
2
3 +> THIS MODULE IS OBSOLETE.
4 +> USE [THE PYTHON ONE](../../python.d.plugin/squid) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
5 +
6 The plugin will monitor a squid server.
7
8 It will produce 4 charts:
collectors/charts.d.plugin/tomcat/README.md
+3 -1
@@ -1,2 +1,4 @@
1 +# tomcat
2 +
3 > THIS MODULE IS OBSOLETE.
2 -> USE THE PYTHON ONE - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
4 +> USE [THE PYTHON ONE](../../python.d.plugin/tomcat) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
docs/generator/buildhtml.sh
-14
@@ -22,20 +22,6 @@ sed -i '0,/# netdata /s//# Introduction\n\n/' ${GENERATOR_DIR}/src/README.md
22 # Remove specific files that don't belong in the documentation
23 declare -a EXCLUDE_LIST=(
24 "HISTORICAL_CHANGELOG.md"
25 - "collectors/charts.d.plugin/mem_apps/README.md"
26 - "collectors/charts.d.plugin/postfix/README.md"
27 - "collectors/charts.d.plugin/tomcat/README.md"
28 - "collectors/charts.d.plugin/sensors/README.md"
29 - "collectors/charts.d.plugin/cpu_apps/README.md"
30 - "collectors/charts.d.plugin/squid/README.md"
31 - "collectors/charts.d.plugin/nginx/README.md"
32 - "collectors/charts.d.plugin/hddtemp/README.md"
33 - "collectors/charts.d.plugin/cpufreq/README.md"
34 - "collectors/charts.d.plugin/mysql/README.md"
35 - "collectors/charts.d.plugin/exim/README.md"
36 - "collectors/charts.d.plugin/apache/README.md"
37 - "collectors/charts.d.plugin/load_average/README.md"
38 - "collectors/charts.d.plugin/phpfpm/README.md"
25 )
26 for f in "${EXCLUDE_LIST[@]}"; do
27 rm "${GENERATOR_DIR}/src/$f"
docs/generator/buildyaml.sh
+24 -1
@@ -161,7 +161,30 @@ navpart 2 collectors/plugins.d "" "External plugins"
161 navpart 3 collectors/python.d.plugin "" "Python modules" 3
162 navpart 3 collectors/node.d.plugin "" "Node.js modules" 3
163 navpart 3 collectors/charts.d.plugin "" "BASH modules" 3
164 -navpart 3 collectors/apps.plugin
164 +echo -ne " - 'collectors/charts.d.plugin/README.md'
165 + - 'collectors/charts.d.plugin/ap/README.md'
166 + - 'collectors/charts.d.plugin/apcupsd/README.md'
167 + - 'collectors/charts.d.plugin/example/README.md'
168 + - 'collectors/charts.d.plugin/libreswan/README.md'
169 + - 'collectors/charts.d.plugin/nut/README.md'
170 + - 'collectors/charts.d.plugin/opensips/README.md'
171 + - Obsolete BASH modules:
172 + - 'collectors/charts.d.plugin/mem_apps/README.md'
173 + - 'collectors/charts.d.plugin/postfix/README.md'
174 + - 'collectors/charts.d.plugin/tomcat/README.md'
175 + - 'collectors/charts.d.plugin/sensors/README.md'
176 + - 'collectors/charts.d.plugin/cpu_apps/README.md'
177 + - 'collectors/charts.d.plugin/squid/README.md'
178 + - 'collectors/charts.d.plugin/nginx/README.md'
179 + - 'collectors/charts.d.plugin/hddtemp/README.md'
180 + - 'collectors/charts.d.plugin/cpufreq/README.md'
181 + - 'collectors/charts.d.plugin/mysql/README.md'
182 + - 'collectors/charts.d.plugin/exim/README.md'
183 + - 'collectors/charts.d.plugin/apache/README.md'
184 + - 'collectors/charts.d.plugin/load_average/README.md'
185 + - 'collectors/charts.d.plugin/phpfpm/README.md'
186 +"
187 +
188 navpart 3 collectors/fping.plugin
189 navpart 3 collectors/freeipmi.plugin
190