blob: 427f9d896dd9d65dfdf5115f74e1c34fae91b023 (
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
#!/bin/bash
GENERATOR_DIR="docs/generator"
docs_dir="${1}"
site_dir="${2}"
language="${3}"
cd ${GENERATOR_DIR}/${docs_dir}
# 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 [[ -n $section ]]; then echo "$spc- ${section}:"; fi
if [ -z "$maxdepth" ]; then maxdepth=1; fi
if [[ -n $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
site_url: https://docs.netdata.cloud
repo_url: https://github.com/netdata/netdata
repo_name: GitHub
edit_uri: blob/master
site_description: Netdata Documentation
copyright: Netdata, 2019
docs_dir: '${docs_dir}'
site_dir: '${site_dir}'
#use_directory_urls: false
strict: true
extra:
social:
- type: "github"
link: "https://github.com/netdata/netdata"
- type: "twitter"
link: "https://twitter.com/linuxnetdata"
- type: "facebook"
link: "https://www.facebook.com/linuxnetdata/"
theme:
name: "material"
palette:
primary: "blue grey"
accent: "light green"
custom_dir: custom/themes/material
favicon: custom/img/favicon.ico
language: '${language}'
extra_css:
- "https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css"
- "custom/css/netdata.css"
extra_javascript:
- "custom/javascripts/cookie-consent.js"
- "https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js"
markdown_extensions:
- extra
- abbr
- attr_list
- def_list
- fenced_code
- footnotes
- tables
- admonition
- meta
- sane_lists
- smarty
- toc:
permalink: True
separator: "-"
- wikilinks
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.highlight:
pygments_style: manni
css_class: "highlight codehilite"
linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.superfences
- markdown.extensions.footnotes
- markdown.extensions.attr_list
- markdown.extensions.def_list
- markdown.extensions.tables
- markdown.extensions.abbr
- pymdownx.extrarawhtml
nav:'
navpart 1 . "README" ""
navpart 1 . . "About Netdata"
echo -ne " - 'docs/what-is-netdata.md'
- 'docs/Demo-Sites.md'
- 'docs/netdata-security.md'
- 'docs/anonymous-statistics.md'
- 'docs/Donations-netdata-has-received.md'
- 'docs/a-github-star-is-important.md'
- REDISTRIBUTED.md
- CHANGELOG.md
- SECURITY.md
- Why Netdata:
- 'docs/why-netdata/README.md'
- 'docs/why-netdata/1s-granularity.md'
- 'docs/why-netdata/unlimited-metrics.md'
- 'docs/why-netdata/meaningful-presentation.md'
- 'docs/why-netdata/immediate-results.md'
- Installation:
- 'packaging/installer/README.md'
- 'packaging/docker/README.md'
- 'packaging/installer/UPDATE.md'
- 'packaging/DISTRIBUTIONS.md'
- 'packaging/installer/UNINSTALL.md'
- 'docs/GettingStarted.md'
- Running Netdata:
- 'daemon/README.md'
- 'docs/configuration-guide.md'
- 'daemon/config/README.md'
"
navpart 2 web/server "" "Web server"
navpart 3 web/server "" "" 2 excludefirstlevel
echo -ne " - Running behind another web server:
- 'docs/Running-behind-nginx.md'
- 'docs/Running-behind-apache.md'
- 'docs/Running-behind-lighttpd.md'
- 'docs/Running-behind-caddy.md'
- 'docs/Running-behind-haproxy.md'
"
#navpart 2 system
navpart 2 database
navpart 2 database/engine
navpart 2 registry
echo -ne " - 'docs/Performance.md'
- 'docs/netdata-for-IoT.md'
- 'docs/high-performance-netdata.md'
"
navpart 1 . netdata-cloud "Netdata Cloud"
echo -ne "
- 'docs/netdata-cloud/README.md'
- 'docs/netdata-cloud/signing-in.md'
- 'docs/netdata-cloud/nodes-view.md'
"
navpart 1 web "README" "Dashboards"
navpart 2 web/gui "" "" 3
navpart 1 collectors "" "Data collection" 1
echo -ne " - 'docs/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/checks.plugin
navpart 3 collectors/diskspace.plugin
navpart 3 collectors/freebsd.plugin
navpart 3 collectors/macos.plugin
navpart 2 collectors/plugins.d "" "External plugins"
echo -ne " - Go:
- 'collectors/go.d.plugin/README.md'
"
navpart 4 collectors/go.d.plugin "" "Modules" 3 excludefirstlevel
echo -ne " - Python:
- 'collectors/python.d.plugin/README.md'
"
navpart 4 collectors/python.d.plugin "" "Modules" 3 excludefirstlevel
echo -ne " - Node.js:
- 'collectors/node.d.plugin/README.md'
"
navpart 4 collectors/node.d.plugin "" "Modules" 3 excludefirstlevel
echo -ne " - BASH:
- 'collectors/charts.d.plugin/README.md'
- Modules:
- 'collectors/charts.d.plugin/ap/README.md'
- 'collectors/charts.d.plugin/apcupsd/README.md'
- 'collectors/charts.d.plugin/example/README.md'
- 'collectors/charts.d.plugin/libreswan/README.md'
- 'collectors/charts.d.plugin/nut/README.md'
- 'collectors/charts.d.plugin/opensips/README.md'
- Obsolete Modules:
- 'collectors/charts.d.plugin/mem_apps/README.md'
- 'collectors/charts.d.plugin/postfix/README.md'
- 'collectors/charts.d.plugin/tomcat/README.md'
- 'collectors/charts.d.plugin/sensors/README.md'
- 'collectors/charts.d.plugin/cpu_apps/README.md'
- 'collectors/charts.d.plugin/squid/README.md'
- 'collectors/charts.d.plugin/nginx/README.md'
- 'collectors/charts.d.plugin/hddtemp/README.md'
- 'collectors/charts.d.plugin/cpufreq/README.md'
- 'collectors/charts.d.plugin/mysql/README.md'
- 'collectors/charts.d.plugin/exim/README.md'
- 'collectors/charts.d.plugin/apache/README.md'
- 'collectors/charts.d.plugin/load_average/README.md'
- 'collectors/charts.d.plugin/phpfpm/README.md'
"
navpart 3 collectors/apps.plugin
navpart 3 collectors/cups.plugin
navpart 3 collectors/fping.plugin
navpart 3 collectors/ioping.plugin
navpart 3 collectors/freeipmi.plugin
navpart 3 collectors/nfacct.plugin
navpart 3 collectors/xenstat.plugin
navpart 3 collectors/perf.plugin
echo -ne " - 'docs/Third-Party-Plugins.md'
"
navpart 1 health README "Alarms and notifications"
navpart 2 health/notifications "" "" 1
navpart 2 health/notifications "" "Supported notifications" 2 excludefirstlevel
navpart 1 streaming "" "" 4
navpart 1 backends "" "Archiving to backends" 3
navpart 1 web/api "" "HTTP API"
navpart 2 web/api/exporters "" "Exporters" 2
navpart 2 web/api/formatters "" "Formatters" 2
navpart 2 web/api/badges "" "" 2
navpart 2 web/api/health "" "" 2
navpart 2 web/api/queries "" "Queries" 2
echo -ne "- Contributing to Netdata:
- CONTRIBUTING.md
- 'docs/contributing/contributing-documentation.md'
- 'docs/contributing/style-guide.md'
- CODE_OF_CONDUCT.md
- CONTRIBUTORS.md
- packaging/maintainers/README.md
"
echo -ne "- Additional information:
"
navpart 2 packaging/makeself "" "" 4
navpart 2 libnetdata "" "libnetdata" 4
navpart 2 contrib
navpart 2 tests "" "" 2
navpart 2 diagrams/data_structures
|
