Wiki Link Updates (#4699)
##### Summary <!--- Describe the change below, including rationale and design decisions --> Replaces links to wiki pages with links to the respective markdown files in the repo. The files with the updates in this PR are not MD files. Fixes #4650 <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue --> ##### Component Name <!--- Write the short name of the module or plugin below --> ##### Additional Information <!--- Include additional information to help people understand the change here --> <!--- A step-by-step reproduction of the problem is helpful if there is no related issue --> <!--- Paste log output below, e.g. before and after your change --> ```paste below ```
Chris Akritidis committed
Nov 21, 2018 at 13:21 UTC
9b305ee4c967c8d006cd58661ac90b76d2c16b56
10 files changed
+37
-37
HISTORICAL_CHANGELOG.md
+6
-6
@@ -127,7 +127,7 @@ netdata (1.6.0) - 2017-03-20
127
menu on the dashboard.
128
129
For more information check:
130
- https://github.com/netdata/netdata/wiki/monitoring-ephemeral-nodes
130
+ https://github.com/netdata/netdata/tree/master/streaming#monitoring-ephemeral-nodes
131
132
* monitoring ephemeral containers and VM guests
133
@@ -135,7 +135,7 @@ netdata (1.6.0) - 2017-03-20
135
disk metrics, disabling automatically their alarms too.
136
137
For more information check:
138
- https://github.com/netdata/netdata/wiki/monitoring-ephemeral-containers
138
+ https://github.com/netdata/netdata/tree/master/collectors/cgroups.plugin#monitoring-ephemeral-containers
139
140
* apps.plugin ported for FreeBSD
141
@@ -150,7 +150,7 @@ netdata (1.6.0) - 2017-03-20
150
and web sites!
151
152
For more information check:
153
- https://github.com/netdata/netdata/wiki/The-spectacles-of-a-web-server-log-file
153
+ https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/web_log#web_log
154
155
* backends
156
@@ -176,7 +176,7 @@ netdata (1.6.0) - 2017-03-20
176
It also supports alarms (including the number of sensors in critical state).
177
178
For more information, check:
179
- https://github.com/netdata/netdata/wiki/monitoring-IPMI
179
+ https://github.com/netdata/netdata/tree/master/collectors/freeipmi.plugin
180
181
* new plugins
182
@@ -446,7 +446,7 @@ netdata (1.3.0) - 2016-08-28
446
required to be installed on a system to allow it work.
447
For more information, please check the installation page:
448
449
- https://github.com/netdata/netdata/wiki/Installation
449
+ https://github.com/netdata/netdata/tree/master/installer#installation
450
451
In detail:
452
@@ -459,7 +459,7 @@ netdata (1.3.0) - 2016-08-28
459
netdata now has a poweful health monitoring system embedded.
460
Please check the wiki page:
461
462
- https://github.com/netdata/netdata/wiki/health-monitoring
462
+ https://github.com/netdata/netdata/tree/master/health
463
464
* netdata has badges!
465
collectors/python.d.plugin/go_expvar/go_expvar.conf
+1
-1
@@ -76,7 +76,7 @@
76
#
77
# Please visit the module wiki page for more information on how to use the extra_charts variable:
78
#
79
-# https://github.com/netdata/netdata/wiki/Monitoring-Go-Applications#monitoring-custom-vars-with-go_expvar
79
+# https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin/go_expvar
80
#
81
# Configuration example
82
# ---------------------
collectors/tc.plugin/tc-qos-helper.sh.in
+1
-1
@@ -100,7 +100,7 @@ if [ ! -d "${fireqos_run_dir}" ]
100
warning "Although FireQoS is installed on this system as '${fireqos}', I cannot find/read its installation configuration at '${fireqos_exec_dir}/install.config'."
101
fi
102
else
103
- warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/wiki/You-should-install-QoS-on-all-your-servers"
103
+ warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/tree/master/collectors/tc.plugin#tcplugin
104
fi
105
fi
106
docker/Dockerfile
+1
-1
@@ -86,7 +86,7 @@ RUN \
86
addgroup -g ${NETDATA_GID} -S netdata && \
87
adduser -S -H -s /usr/sbin/nologin -u ${NETDATA_GID} -h /etc/netdata -G netdata netdata && \
88
# Apply the permissions as described in
89
- # https://github.com/netdata/netdata/wiki/netdata-security#netdata-directories
89
+ # https://github.com/netdata/netdata/tree/master/doc/netdata-security.md#netdata-directories
90
chown -R root:netdata /etc/netdata && \
91
chown -R netdata:netdata /var/cache/netdata /var/lib/netdata /usr/share/netdata && \
92
chown -R root:netdata /usr/lib/netdata && \
netdata-installer.sh
+1
-1
@@ -930,7 +930,7 @@ Update check on the dashboard, will not work.
930
If you want to have version update check, please re-install it
931
following the procedure in:
932
933
-https://github.com/netdata/netdata/wiki/Installation
933
+https://github.com/netdata/netdata/tree/master/installer#installation
934
935
VERMSG
936
fi
web/gui/dashboard_info.js
+3
-3
@@ -892,7 +892,7 @@ netdataDashboard.context = {
892
},
893
894
'apps.vmem': {
895
- info: 'Virtual memory allocated by applications. Please check <a href="https://github.com/netdata/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
895
+ info: 'Virtual memory allocated by applications. Please check <a href="https://github.com/netdata/netdata/tree/master/daemon#virtual-memory" target="_blank">this article</a> for more information.'
896
},
897
898
'apps.preads': {
@@ -915,7 +915,7 @@ netdataDashboard.context = {
915
},
916
917
'users.vmem': {
918
- info: 'Virtual memory allocated per user. Please check <a href="https://github.com/netdata/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
918
+ info: 'Virtual memory allocated per user. Please check <a href="https://github.com/netdata/netdata/tree/master/daemon#virtual-memory" target="_blank">this article</a> for more information.'
919
},
920
921
'users.preads': {
@@ -938,7 +938,7 @@ netdataDashboard.context = {
938
},
939
940
'groups.vmem': {
941
- info: 'Virtual memory allocated per user group. Please check <a href="https://github.com/netdata/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
941
+ info: 'Virtual memory allocated per user group. Please check <a href="https://github.com/netdata/netdata/tree/master/daemon#virtual-memory" target="_blank">this article</a> for more information.'
942
},
943
944
'groups.preads': {
web/gui/demosites.html
+20
-20
@@ -680,7 +680,7 @@ p {
680
with stunning, <strong>interactive</strong> web dashboards
681
and powerful <strong>performance</strong> and <strong>health</strong> alarms.
682
<div class=cta-option>
683
- <a class="btn btn-download" href=https://github.com/netdata/netdata/wiki/Installation data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Install><strong>Install netdata now</strong></a>
683
+ <a class="btn btn-download" href=https://github.com/netdata/netdata/tree/master/installer#installation data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Install><strong>Install netdata now</strong></a>
684
<a class=last-update href=https://github.com/netdata/netdata/releases data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Releases>See netdata releases</a></div>
685
<div class=cta-option>
686
<a class="btn btn-alt" href="#demosites" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Demo>netdata live demo</a>
@@ -694,55 +694,55 @@ p {
694
<p>
695
Analyze thousands of metrics per server.
696
<br/>
697
- Everything about <a href="https://github.com/netdata/netdata/wiki/Internal-Plugins" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=InternalPlugins>the system</a> (CPU,
698
- RAM, <a href="https://github.com/netdata/netdata/wiki/Monitoring-disks" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MonitoringDisks>disks</a>,
699
- network, firewall, <a href="https://github.com/netdata/netdata/wiki/Why-netdata%3F#visualizes-qos" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=QoS>QoS</a>, NFS, ZFS, etc).
697
+ Everything about <a href="https://github.com/netdata/netdata/tree/master/collectors" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=InternalPlugins>the system</a> (CPU,
698
+ RAM, <a href="https://github.com/netdata/netdata/tree/master/collectors/proc.plugin#monitoring-disks" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MonitoringDisks>disks</a>,
699
+ network, firewall, <a href="https://github.com/netdata/netdata/tree/master/collectors/tc.plugin" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=QoS>QoS</a>, NFS, ZFS, etc).
700
<br/>
701
Detailed performance metrics for dozens of
702
<b><a href="https://github.com/netdata/netdata/blob/master/doc/Add-more-charts-to-netdata.md#add-more-charts-to-netdata" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AddMoreCharts>applications</a></b>
703
(such as web servers, databases servers, email servers, DNS servers, etc).
704
<br/>
705
- Visualize metrics collected from <b><a href="https://github.com/netdata/netdata/blob/master/conf.d/node.d/snmp.conf.md" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=SNMP>SNMP devices</a></b>,
706
- and APM metrics via the embedded <b><a href="https://github.com/netdata/netdata/wiki/statsd" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=statsd>statsd server</a></b>.
705
+ Visualize metrics collected from <b><a href="https://github.com/netdata/netdata/blob/master/collectors/node.d.plugin/snmp" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=SNMP>SNMP devices</a></b>,
706
+ and APM metrics via the embedded <b><a href="https://github.com/netdata/netdata/tree/master/collectors/statsd.plugin" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=statsd>statsd server</a></b>.
707
</div>
708
<div class=grid-cell><h3><span class=star>★</span> Out of the box</h3>
709
- <p>netdata supports <a href="https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AutoDetection>auto-detection</a> for everything. It collects more than 5000 metrics automatically, with
709
+ <p>netdata supports <a href="https://github.com/netdata/netdata/tree/master/doc/Why-Netdata.md#simplicity" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AutoDetection>auto-detection</a> for everything. It collects more than 5000 metrics automatically, with
710
<strong>zero configuration</strong>, it has <strong>zero dependencies</strong>, requires <strong>zero
711
maintenance</strong> and comes with more than <a href="https://github.com/netdata/netdata/tree/master/health/health.d" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AlarmConfigs>100 alarms</a> pre-configured to detect common
712
failures, performance and availability issues.
713
</div>
714
<div class=grid-cell><h3><span class=star>★</span> In real-time</h3>
715
<p>netdata collects thousands of metrics per server <strong>per second</strong>,
716
- with <a href="https://github.com/netdata/netdata/wiki/Performance#netdata-daemon" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Performance>just 1% CPU</a>
717
- utilization of a single core, <a href="https://github.com/netdata/netdata/wiki/Memory-Requirements" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MemoryRequirements>a few MB of RAM</a>
716
+ with <a href="https://github.com/netdata/netdata/blob/master/doc/Performance.md#netdata-performance" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Performance>just 1% CPU</a>
717
+ utilization of a single core, <a href="https://github.com/netdata/netdata/tree/master/database" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MemoryRequirements>a few MB of RAM</a>
718
and no disk I/O at all.
719
View everything on <strong>stunning</strong> real-time interactive web dashboards, even when netdata is
720
running on low-end hardware.
721
</div>
722
<div class=grid-cell><h3><span class=star>★</span> With alarms</h3>
723
- <p><a href="https://github.com/netdata/netdata/wiki/health-monitoring" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Alarms>Alarms</a>
723
+ <p><a href="https://github.com/netdata/netdata/tree/master/health" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Alarms>Alarms</a>
724
can be set on any metric monitored by netdata.
725
- Alarm <a href="https://github.com/netdata/netdata/wiki/health-monitoring#alarm-actions" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AlarmNotifications>notifications</a>
725
+ Alarm <a href="https://github.com/netdata/netdata/tree/master/health" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=AlarmNotifications>notifications</a>
726
are role-based and support dynamic thresholds, hysteresis and can be dispatched via multiple methods
727
(such as email, slack.com, pushover.net, pushbullet.com, telegram.org, twilio.com).
728
</div>
729
<div class=grid-cell><h3><span class=star>★</span> Embeddable</h3>
730
- <p>netdata has minimal dependencies and can run <b><a href="https://github.com/netdata/netdata/wiki/netdata-for-IoT" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=IoT>even weak on IoT devices</a></b>. Also, its charts can be embedded on any web site.
730
+ <p>netdata has minimal dependencies and can run <b><a href="https://github.com/netdata/netdata/blob/master/doc/netdata-for-IoT.md#netdata-for-iot" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=IoT>even weak on IoT devices</a></b>. Also, its charts can be embedded on any web site.
731
</div>
732
<div class=grid-cell><h3><span class=star>★</span> Customizable</h3>
733
- <p><a href="https://github.com/netdata/netdata/wiki/Custom-Dashboards" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=CustomDashboards>Custom dashboards</a> can be built using simple HTML (no javascript necessary).
733
+ <p><a href="https://github.com/netdata/netdata/tree/master/web/gui/custom#custom-dashboards" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=CustomDashboards>Custom dashboards</a> can be built using simple HTML (no javascript necessary).
734
</div>
735
<div class=grid-cell><h3><span class=star>★</span> Extensible</h3>
736
- <p>Anything you can get a number for, can be given to netdata, using its <a href="https://github.com/netdata/netdata/wiki/External-Plugins" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=ExternalPlugins>Plugin API</a> (anything can be a netdata plugin, BASH, python, perl, node.js, java, Go, ruby, etc).
736
+ <p>Anything you can get a number for, can be given to netdata, using its <a href="https://github.com/netdata/netdata/tree/master/collectors/plugins.d" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=ExternalPlugins>Plugin API</a> (anything can be a netdata plugin, BASH, python, perl, node.js, java, Go, ruby, etc).
737
</div>
738
<div class=grid-cell><h3><span class=star>★</span> Scalable</h3>
739
<p>
740
netdata scales out, your web browser is the central netdata
741
- <a href="https://github.com/netdata/netdata/wiki/mynetdata-menu-item" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MyNetdataMenu>connecting all your servers</a>
741
+ <a href="https://github.com/netdata/netdata/tree/master/registry" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=MyNetdataMenu>connecting all your servers</a>
742
together. But netdata can also
743
- <a href="https://github.com/netdata/netdata/wiki/Replication-Overview" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Streaming>replicate its database</a>
743
+ <a href="https://github.com/netdata/netdata/tree/master/streaming#metrics-streaming" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Streaming>replicate its database</a>
744
to other netdata, and
745
- <a href="https://github.com/netdata/netdata/wiki/netdata-backends" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Backends>archive its metrics</a>
745
+ <a href="https://github.com/netdata/netdata/tree/master/backends" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=Backends>archive its metrics</a>
746
to <strong>graphite</strong>, <strong>opentsdb</strong>, <strong>influxdb</strong> or <strong>prometheus</strong> at a lower
747
rate, to avoid congesting these servers with the amount of data collected.
748
</div>
@@ -1082,7 +1082,7 @@ p {
1082
<div class=site-section><h2>Who uses netdata?</h2>
1083
<div class="content">
1084
<div class="container" style="text-align: center;">
1085
- <small>Figures come from users using the <a href="https://github.com/netdata/netdata/wiki/mynetdata-menu-item" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=GlobalRegistry>netdata public global registry</a>.<br/>Counting since May 16th 2016. Actual figures may be a lot higher.<br/></small>
1085
+ <small>Figures come from users using the <a href="https://github.com/netdata/netdata/tree/master/registry" target="_blank" data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=GlobalRegistry>netdata public global registry</a>.<br/>Counting since May 16th 2016. Actual figures may be a lot higher.<br/></small>
1086
<div class="container" style="padding-top: 40px; text-align: center; width: 30%; min-width: 220px; display: inline-block;">
1087
<div class="mysparkline">
1088
<div class="mysparkline-overchart-label">
@@ -1155,7 +1155,7 @@ p {
1155
<embed src="//registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&refresh=30&v42" type="image/svg+xml" height="20" />
1156
<embed src="//registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=null&value_color=orange&precision=0&refresh=30&v42" type="image/svg+xml" height="20" />
1157
<embed src="//registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=null&value_color=yellowgreen&precision=0&refresh=30&v42" type="image/svg+xml" height="20" />
1158
- <br/><i>(figures come from <a href="https://github.com/netdata/netdata/wiki/mynetdata-menu-item" target="_blank">the public netdata registry</a> data, showing only installations that use this registry, counting since May 16th 2016)</i>
1158
+ <br/><i>(figures come from <a href="https://github.com/netdata/netdata/tree/master/registry" target="_blank">the public netdata registry</a> data, showing only installations that use this registry, counting since May 16th 2016)</i>
1159
<br/>
1160
-->
1161
</p>
@@ -1180,7 +1180,7 @@ p {
1180
</div>
1181
</div>
1182
<div class=cta-option>
1183
- <a class="btn btn-download" href=https://github.com/netdata/netdata/wiki/Installation data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=InstallAfterDemo><strong>Install netdata now</strong></a>
1183
+ <a class="btn btn-download" href=https://github.com/netdata/netdata/tree/master/installer#installation data-ga-category="Outbound links" data-ga-action="Nav click" data-ga-label=InstallAfterDemo><strong>Install netdata now</strong></a>
1184
</div>
1185
</div>
1186
</div>
web/gui/demosites2.html
+2
-2
@@ -597,7 +597,7 @@
597
bandwidth consumption on the demo sites
598
</div>
599
<div class="mycontent">
600
- Linux QoS is configured by <a href="https://github.com/netdata/netdata/wiki/You-should-install-QoS-on-all-your-servers">FireQOS</a>
600
+ Linux QoS is configured by <a href="https://github.com/netdata/netdata/tree/master/collectors/tc.plugin#tcplugin">FireQOS</a>
601
</div>
602
603
<!-- Nav tabs -->
@@ -719,7 +719,7 @@
719
DDoS protection performance on the demo sites
720
</div>
721
<div class="mycontent">
722
- iptables SYNPROXY configured by <a href="https://github.com/netdata/netdata/wiki/Monitoring-SYNPROXY">FireHOL</a>
722
+ iptables SYNPROXY configured by <a href="https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md#linux-anti-ddos">FireHOL</a>
723
</div>
724
725
<div style="padding-top: 4vw; width: 100%; text-align: center; font-size: 1.5vw;">
web/gui/index.html
+1
-1
@@ -457,7 +457,7 @@
457
<div class="p">
458
<b><a href="https://github.com/netdata/netdata/wiki" target="_blank">netdata</a></b> is free,
459
open-source software. If you decide to use it,
460
- <strong><a href="https://github.com/netdata/netdata/wiki/a-github-star-is-important" target="_blank">it is important to give netdata a star at GitHub</a></strong>.
460
+ <strong><a href="https://github.com/netdata/netdata/tree/master/doc/a-github-star-is-important.md" target="_blank">it is important to give netdata a star at GitHub</a></strong>.
461
</div>
462
<div class="p">
463
Enjoy real-time performance monitoring!
web/gui/main.js
+1
-1
@@ -2801,7 +2801,7 @@ function notifyForUpdate(force) {
2801
save = true;
2802
var compare = 'https://github.com/netdata/netdata/compare/' + sha1.toString() + '...' + sha2.toString();
2803
2804
- versionLog('<p><big><strong>New version of netdata available!</strong></big></p><p>Latest commit: <b><code>' + sha2.substring(0, 7).toString() + '</code></b></p><p><a href="' + compare + '" target="_blank">Click here for the changes log</a> since your installed version, and<br/><a href="https://github.com/netdata/netdata/wiki/Updating-Netdata" target="_blank">click here for directions on updating</a> your netdata installation.</p><p>We suggest to review the changes log for new features you may be interested, or important bug fixes you may need.<br/>Keeping your netdata updated, is generally a good idea.</p>');
2804
+ versionLog('<p><big><strong>New version of netdata available!</strong></big></p><p>Latest commit: <b><code>' + sha2.substring(0, 7).toString() + '</code></b></p><p><a href="' + compare + '" target="_blank">Click here for the changes log</a> since your installed version, and<br/><a href="https://github.com/netdata/netdata/tree/master/installer/UPDATE.md" target="_blank">click here for directions on updating</a> your netdata installation.</p><p>We suggest to review the changes log for new features you may be interested, or important bug fixes you may need.<br/>Keeping your netdata updated, is generally a good idea.</p>');
2805
2806
document.getElementById('update_badge').innerHTML = '!';
2807
}