blob: 6538d39b749e5a4ce96c21834771b2d2a4db08fd (
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
#!/bin/bash
# shellcheck disable=SC2181
# Doc link checker
# Validates and tries to fix all links that will cause issues either in the repo, or in the html site
GENERATOR_DIR="docs/generator"
dbg () {
if [ "$VERBOSE" -eq 1 ] ; then printf "%s\\n" "${1}" ; fi
}
printhelp () {
echo "Usage: docs/generator/checklinks.sh [-r OR -f <fname>] [OPTIONS]
-r Recursively check all mds in all child directories, except docs/generator and node_modules (which is generatord by netlify)
-f Just check the passed md file
General Options:
-x Execute commands. By default the script runs in test mode with no files changed by the script (results and fixes are just shown). Use -x to have it apply the changes.
-u trys to follow URLs using curl
-v Outputs debugging messages
By default, nothing is actually checked. The following options tell it what to check:
-a Check all link types
-w Check wiki links (and just warn if you see one)
-b Check absolute links to the netdata repo (and change them to relative). Only checks links to https://github.com/netdata/netdata/????/master*
-l Check relative links to the netdata repo (and replace them with links that the html static site can live with, under docs/generator/src only)
-e Check external links, outside the wiki or the repo (useless without adding the -u option, to verify that they're not broken)
"
}
fix () {
if [ "$EXECUTE" -eq 0 ] ; then
echo "-- SHOULD EXECUTE: $1"
else
dbg "-- EXECUTING: $1"
eval "$1"
fi
}
testURL () {
if [ "$TESTURLS" -eq 0 ] ; then return 0 ; fi
dbg "-- Testing URL $1"
curl -sS "$1" > /dev/null
if [ $? -gt 0 ] ; then
return 1
fi
return 0
}
testinternal () {
# Check if the header referred to by the internal link exists in the same file
ff=${1}
ifile=${2}
ilnk=${3}
header=${ilnk//-/}
dbg "-- Searching for \"$header\" in $ifile"
tr -d '[],_.:? `'< "$ifile" | sed 's/-//g' | grep -i "^\\#*$header\$" >/dev/null
if [ $? -eq 0 ] ; then
dbg "-- $ilnk found in $ifile"
return 0
else
echo "-- ERROR: $ff - $ilnk header not found in file $ifile"
EXITCODE=1
return 1
fi
}
testf () {
sf=$1
tf=$2
if [ -f "$tf" ] ; then
dbg "-- $tf exists"
return 0
else
echo "-- ERROR: $sf - $tf does not exist"
EXITCODE=1
return 1
fi
}
ck_netdata_relative () {
f=${1}
rlnk=${2}
dbg "-- Checking relative link $rlnk"
fpath="."
fname="$f"
# First ensure that the link works in the repo, then try to fix it in htmldocs
if [[ $f =~ ^(.*)/([^/]*)$ ]] ; then
fpath="${BASH_REMATCH[1]}"
fname="${BASH_REMATCH[2]}"
dbg "-- Current file is at $fpath"
else
dbg "-- Current file is at root directory"
fi
# Cases to handle:
# (#somelink)
# (path/)
# (path/#somelink)
# (path/filename.md) -> htmldoc (path/filename/)
# (path/filename.md#somelink) -> htmldoc (path/filename/#somelink)
# (path#somelink) -> htmldoc (path/#somelink)
# (path/someotherfile) -> htmldoc (absolutelink)
# (path) -> htmldoc (path/)
TRGT=""
s=""
case "$rlnk" in
\#* )
dbg "-- # (#somelink)"
testinternal "$f" "$f" "$rlnk"
;;
*/ )
dbg "-- # (path/)"
TRGT="$fpath/${rlnk}README.md"
testf "$f" "$TRGT"
if [ $? -eq 0 ] ; then
if [ "$fname" != "README.md" ] ; then s="../$rlnk"; fi
fi
;;
*/\#* )
dbg "-- # (path/#somelink)"
if [[ $rlnk =~ ^(.*)/#(.*)$ ]] ; then
TRGT="$fpath/${BASH_REMATCH[1]}/README.md"
LNK="#${BASH_REMATCH[2]}"
dbg "-- Look for $LNK in $TRGT"
testf "$f" "$TRGT"
if [ $? -eq 0 ] ; then
testinternal "$f" "$TRGT" "$LNK"
if [ $? -eq 0 ] ; then
if [ "$fname" != "README.md" ] ; then s="../$rlnk"; fi
fi
fi
fi
;;
*.md )
dbg "-- # (path/filename.md) -> htmldoc (path/filename/)"
testf "$f" "$fpath/$rlnk"
if [ $? -eq 0 ] ; then
if [[ $rlnk =~ ^(.*)/(.*).md$ ]] ; then
if [ "${BASH_REMATCH[2]}" = "README" ] ; then
s="../${BASH_REMATCH[1]}/"
else
s="../${BASH_REMATCH[1]}/${BASH_REMATCH[2]}/"
fi
if [ "$fname" != "README.md" ] ; then s="../$s"; fi
fi
fi
;;
*.md\#* )
dbg "-- # (path/filename.md#somelink) -> htmldoc (path/filename/#somelink)"
if [[ $rlnk =~ ^(.*)#(.*)$ ]] ; then
TRGT="$fpath/${BASH_REMATCH[1]}"
LNK="#${BASH_REMATCH[2]}"
testf "$f" "$TRGT"
if [ $? -eq 0 ] ; then
testinternal "$f" "$TRGT" "$LNK"
if [ $? -eq 0 ] ; then
if [[ $lnk =~ ^(.*)/(.*).md#(.*)$ ]] ; then
if [ "${BASH_REMATCH[2]}" = "README" ] ; then
s="../${BASH_REMATCH[1]}/#${BASH_REMATCH[3]}"
else
s="../${BASH_REMATCH[1]}/${BASH_REMATCH[2]}/#${BASH_REMATCH[3]}"
fi
if [ "$fname" != "README.md" ] ; then s="../$s"; fi
fi
fi
fi
fi
;;
*\#* )
dbg "-- # (path#somelink) -> (path/#somelink)"
if [[ $rlnk =~ ^(.*)#(.*)$ ]] ; then
TRGT="$fpath/${BASH_REMATCH[1]}/README.md"
LNK="#${BASH_REMATCH[2]}"
testf "$f" "$TRGT"
if [ $? -eq 0 ] ; then
testinternal "$f" "$TRGT" "$LNK"
if [ $? -eq 0 ] ; then
if [[ $rlnk =~ ^(.*)#(.*)$ ]] ; then
s="${BASH_REMATCH[1]}/#${BASH_REMATCH[2]}"
if [ "$fname" != "README.md" ] ; then s="../$s"; fi
fi
fi
fi
fi
;;
* )
if [ -f "$fpath/$rlnk" ] ; then
dbg "-- # (path/someotherfile) $rlnk"
if [ "$fpath" = "." ] ; then
s="https://github.com/netdata/netdata/tree/master/$rlnk"
else
s="https://github.com/netdata/netdata/tree/master/$fpath/$rlnk"
fi
else
if [ -d "$fpath/$rlnk" ] ; then
dbg "-- # (path) -> htmldoc (path/)"
testf "$f" "$fpath/$rlnk/README.md"
if [ $? -eq 0 ] ; then
s="$rlnk/"
if [ "$fname" != "README.md" ] ; then s="../$s"; fi
fi
else
echo "-- ERROR: $f - $rlnk is neither a file or a directory. Giving up!"
EXITCODE=1
fi
fi
;;
esac
if [[ ! -z $s ]] ; then
srch=$(echo "$rlnk" | sed 's/\//\\\//g')
rplc=$(echo "$s" | sed 's/\//\\\//g')
fix "sed -i 's/($srch)/($rplc)/g' $GENERATOR_DIR/doc/$f"
fi
}
checklinks () {
f=$1
dbg "Checking $f"
while read -r l ; do
for word in $l ; do
if [[ $word =~ .*\]\(([^\(\) ]*)\).* ]] ; then
lnk="${BASH_REMATCH[1]}"
if [ -z "$lnk" ] ; then continue ; fi
dbg "-
|