blob: 096e4ce5c1ad36fe45e20d66c1c84f065a3ac779 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
#!/bin/bash
cd htmldoc/src
# create yaml nav subtree with all the files directly under a specific directory
# arguments:
# tabs - how deep do we show it in the hierarchy. Level 1 is the top level, max should probably be 3
# directory - to get mds from to add them to the yaml
# file - can be left empty to include all files
# name - what do we call the relevant section on the navbar. Empty if no new section is required
# maxdepth - how many levels of subdirectories do I include in the yaml in this section. 1 means just the top level and is the default if left empty
# excludefirstlevel - Optional param. If passed, mindepth is set to 2, to exclude the READMEs in the first directory level
navpart () {
tabs=$1
dir=$2
file=$3
section=$4
maxdepth=$5
excludefirstlevel=$6
spc=""
i=1
while [ ${i} -lt ${tabs} ] ; do
spc=" $spc"
i=$[$i + 1]
done
if [ -z "$file" ] ; then file='*' ; fi
if [[ ! -z "$section" ]] ; then echo "$spc- ${section}:" ; fi
if [ -z "$maxdepth" ] ; then maxdepth=1; fi
if [[ ! -z "$excludefirstlevel" ]] ; then mindepth=2 ; else mindepth=1; fi
for f in $(find $dir -mindepth $mindepth -maxdepth $maxdepth -name "${file}.md" -printf '%h\0%d\0%p\n' | sort -t '\0' -n | awk -F '\0' '{print $3}'); do
# If I'm adding a section, I need the child links to be one level deeper than the requested level in "tabs"
if [ -z "$section" ] ; then
echo "$spc- '$f'"
else
echo "$spc - '$f'"
fi
done
}
echo -e 'site_name: NetData Documentation
repo_url: https://github.com/netdata/netdata
repo_name: GitHub
edit_uri: blob/master
site_description: NetData Documentation
copyright: NetData, 2018
docs_dir: src
site_dir: build
#use_directory_urls: false
theme:
name: "material"
custom_dir: themes/material
markdown_extensions:
- extra
- abbr
- attr_list
- def_list
- fenced_code
- footnotes
- tables
- admonition
- codehilite
- meta
- nl2br
- sane_lists
- smarty
- toc:
permalink: True
separator: "-"
- wikilinks
nav:'
navpart 1 . README "Getting Started"
echo -ne " - 'doc/Why-Netdata.md'
- 'doc/Demo-Sites.md'
- Installation:
- 'installer/README.md'
- 'docker/README.md'
- 'installer/UPDATE.md'
- 'installer/UNINSTALL.md'
"
echo -ne "- Using NetData:
"
navpart 2 daemon
navpart 2 web "README" "Web Dashboards"
navpart 3 web/gui "" "" 3
navpart 2 web/server "" "Web Server"
navpart 3 web/server "" "" 2 excludefirstlevel
navpart 2 web/api "" "Web API"
navpart 3 web/api "" "" 4 excludefirstlevel
navpart 2 daemon/config
#navpart 2 system
navpart 2 registry
navpart 2 streaming "" "" 4
navpart 2 backends "" "Backends" 3
navpart 2 database
echo -ne " - 'doc/Performance.md'
- 'doc/netdata-for-IoT.md'
- 'doc/high-performance-netdata.md'
- 'doc/netdata-security.md'
- 'doc/Netdata-Security-and-Disclosure-Information.md'
"
navpart 2 health README "Health Monitoring"
navpart 3 health/notifications "" "" 1
navpart 3 health/notifications "" "Supported Notifications" 2 excludefirstlevel
echo -ne " - Running-behind-another-web-server:
- 'doc/Running-behind-nginx.md'
- 'doc/Running-behind-apache.md'
- 'doc/Running-behind-lighttpd.md'
- 'doc/Running-behind-caddy.md'
"
navpart 1 collectors "" "Data Collection" 1
echo -ne " - 'doc/Add-more-charts-to-netdata.md'
- Internal Plugins:
"
navpart 3 collectors/proc.plugin
navpart 3 collectors/statsd.plugin
navpart 3 collectors/cgroups.plugin
navpart 3 collectors/idlejitter.plugin
navpart 3 collectors/tc.plugin
navpart 3 collectors/nfacct.plugin
navpart 3 collectors/checks.plugin
navpart 3 collectors/diskspace.plugin
navpart 3 collectors/freebsd.plugin
navpart 3 collectors/macos.plugin
navpart 2 collectors/plugins.d "" "External Plugins"
navpart 3 collectors/python.d.plugin "" "Python Plugins" 3
navpart 3 collectors/node.d.plugin "" "Node.js Plugins" 3
navpart 3 collectors/charts.d.plugin "" "BASH Plugins" 3
navpart 3 collectors/apps.plugin
navpart 3 collectors/fping.plugin
navpart 3 collectors/freeipmi.plugin
echo -ne " - Third Party Plugins:
- 'doc/Third-Party-Plugins.md'
"
echo -ne "- Hacking netdata:
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
- CONTRIBUTORS.md
"
navpart 2 makeself "" "" 4
navpart 2 packaging "" "" 4
navpart 2 libnetdata "" "libnetdata" 4
navpart 2 contrib
navpart 2 tests
navpart 2 diagrams/data_structures
echo -ne "- About:
- 'doc/Donations-netdata-has-received.md'
- 'doc/a-github-star-is-important.md'
- CHANGELOG.md
- HISTORICAL_CHANGELOG.md
- REDISTRIBUTED.md
"
|
