@cryptotaxi247 / netdata-1 / commits / d054de077

Add go.d documentation and modify collector menu (#5215)

docs/generator/buildyaml.sh * Modified menu structure of collectors * Added go.d plugin docs/generator/buildhtml.sh * Added go.d documentation (git clone). Clean up the go.d cloned dir before and after execution * Replace page edit links to github for go.d.plugin. Removed nomkdocs option which doesn't work with this.

Chris Akritidis committed Feb 6, 2019 at 16:00 UTC d054de0771b23f345ef80b33e29d1ede3d8f312c
3 files changed +55 -29
.gitignore
+1
@@ -106,6 +106,7 @@ collectors/charts.d.plugin/charts.d.plugin
106 collectors/node.d.plugin/node.d.plugin
107 collectors/python.d.plugin/python.d.plugin
108 collectors/fping.plugin/fping.plugin
109 +collectors/go.d.plugin
110
111 # installer generated files
112 netdata-uninstaller.sh
docs/generator/buildhtml.sh
+15 -5
@@ -14,6 +14,10 @@ if [ "$currentdir" = "generator" ]; then
14 fi
15 GENERATOR_DIR="docs/generator"
16
17 +# Fetch go.d.plugin docs
18 +rm -rf ./collectors/go.d.plugin
19 +git clone https://github.com/netdata/go.d.plugin.git ./collectors/go.d.plugin
20 +
21 # Copy all netdata .md files to docs/generator/src. Exclude htmldoc itself and also the directory node_modules generatord by Netlify
22 echo "Copying files"
23 rm -rf ${GENERATOR_DIR}/src
@@ -22,6 +26,8 @@ find . -type d \( -path ./${GENERATOR_DIR} -o -path ./node_modules \) -prune -o
26 # Copy netdata html resources
27 cp -a ./${GENERATOR_DIR}/custom ./${GENERATOR_DIR}/src/
28
29 +
30 +
31 # Modify the first line of the main README.md, to enable proper static html generation
32 echo "Modifying README header"
33 sed -i -e '0,/# netdata /s//# Introduction\n\n/' ${GENERATOR_DIR}/src/README.md
@@ -50,11 +56,15 @@ echo "Fixing links"
56 # Fix links (recursively, all types, executing replacements)
57 ${GENERATOR_DIR}/checklinks.sh -rax
58
53 -if [ "${1}" != "nomkdocs" ] ; then
54 - echo "Calling mkdocs"
59 +echo "Calling mkdocs"
60
56 - # Build html docs
57 - mkdocs build --config-file=${GENERATOR_DIR}/mkdocs.yml
58 -fi
61 +# Build html docs
62 +mkdocs build --config-file=${GENERATOR_DIR}/mkdocs.yml
63 +
64 +# Fix edit buttons for the markdowns that are not on the main netdata repo
65 +find ${GENERATOR_DIR}/build/collectors/go.d.plugin -name "*.html" -print0 | xargs -0 sed -i -e 's/https:\/\/github.com\/netdata\/netdata\/blob\/master\/collectors\/go.d.plugin/https:\/\/github.com\/netdata\/go.d.plugin\/blob\/master/g'
66 +
67 +# Remove the cloned go.d.plugin project
68 +rm -rf ./collectors/go.d.plugin
69
70 echo "Finished"
docs/generator/buildyaml.sh
+39 -24
@@ -174,31 +174,46 @@ navpart 3 collectors/freebsd.plugin
174 navpart 3 collectors/macos.plugin
175
176 navpart 2 collectors/plugins.d "" "External plugins"
177 -navpart 3 collectors/python.d.plugin "" "Python modules" 3
178 -navpart 3 collectors/node.d.plugin "" "Node.js modules" 3
179 -echo -ne " - BASH modules:
177 +
178 +echo -ne " - Go:
179 + - 'collectors/go.d.plugin/README.md'
180 +"
181 +navpart 4 collectors/go.d.plugin "" "Modules" 3 excludefirstlevel
182 +
183 +echo -ne " - Python:
184 + - 'collectors/python.d.plugin/README.md'
185 +"
186 +navpart 4 collectors/python.d.plugin "" "Modules" 3 excludefirstlevel
187 +
188 +echo -ne " - Node.js:
189 + - 'collectors/node.d.plugin/README.md'
190 +"
191 +navpart 4 collectors/node.d.plugin "" "Modules" 3 excludefirstlevel
192 +
193 +echo -ne " - BASH:
194 - 'collectors/charts.d.plugin/README.md'
181 - - 'collectors/charts.d.plugin/ap/README.md'
182 - - 'collectors/charts.d.plugin/apcupsd/README.md'
183 - - 'collectors/charts.d.plugin/example/README.md'
184 - - 'collectors/charts.d.plugin/libreswan/README.md'
185 - - 'collectors/charts.d.plugin/nut/README.md'
186 - - 'collectors/charts.d.plugin/opensips/README.md'
187 - - Obsolete BASH modules:
188 - - 'collectors/charts.d.plugin/mem_apps/README.md'
189 - - 'collectors/charts.d.plugin/postfix/README.md'
190 - - 'collectors/charts.d.plugin/tomcat/README.md'
191 - - 'collectors/charts.d.plugin/sensors/README.md'
192 - - 'collectors/charts.d.plugin/cpu_apps/README.md'
193 - - 'collectors/charts.d.plugin/squid/README.md'
194 - - 'collectors/charts.d.plugin/nginx/README.md'
195 - - 'collectors/charts.d.plugin/hddtemp/README.md'
196 - - 'collectors/charts.d.plugin/cpufreq/README.md'
197 - - 'collectors/charts.d.plugin/mysql/README.md'
198 - - 'collectors/charts.d.plugin/exim/README.md'
199 - - 'collectors/charts.d.plugin/apache/README.md'
200 - - 'collectors/charts.d.plugin/load_average/README.md'
201 - - 'collectors/charts.d.plugin/phpfpm/README.md'
195 + - Modules:
196 + - 'collectors/charts.d.plugin/ap/README.md'
197 + - 'collectors/charts.d.plugin/apcupsd/README.md'
198 + - 'collectors/charts.d.plugin/example/README.md'
199 + - 'collectors/charts.d.plugin/libreswan/README.md'
200 + - 'collectors/charts.d.plugin/nut/README.md'
201 + - 'collectors/charts.d.plugin/opensips/README.md'
202 + - Obsolete Modules:
203 + - 'collectors/charts.d.plugin/mem_apps/README.md'
204 + - 'collectors/charts.d.plugin/postfix/README.md'
205 + - 'collectors/charts.d.plugin/tomcat/README.md'
206 + - 'collectors/charts.d.plugin/sensors/README.md'
207 + - 'collectors/charts.d.plugin/cpu_apps/README.md'
208 + - 'collectors/charts.d.plugin/squid/README.md'
209 + - 'collectors/charts.d.plugin/nginx/README.md'
210 + - 'collectors/charts.d.plugin/hddtemp/README.md'
211 + - 'collectors/charts.d.plugin/cpufreq/README.md'
212 + - 'collectors/charts.d.plugin/mysql/README.md'
213 + - 'collectors/charts.d.plugin/exim/README.md'
214 + - 'collectors/charts.d.plugin/apache/README.md'
215 + - 'collectors/charts.d.plugin/load_average/README.md'
216 + - 'collectors/charts.d.plugin/phpfpm/README.md'
217 "
218
219 navpart 3 collectors/fping.plugin