diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2018-12-28 14:38:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2018-12-28 14:38:58 +0000 |
commit | fa4ece01aed54c9a146af868be0d3db611ded229 (patch) | |
tree | 319cffc5f6c2abd7cce514383716153469fc6295 /htmldoc | |
parent | New upstream version 1.11.0+dfsg (diff) | |
download | netdata-fa4ece01aed54c9a146af868be0d3db611ded229.tar.xz netdata-fa4ece01aed54c9a146af868be0d3db611ded229.zip |
New upstream version 1.11.1+dfsgupstream/1.11.1+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'htmldoc')
-rwxr-xr-x | htmldoc/buildhtml.sh | 33 | ||||
-rwxr-xr-x | htmldoc/buildyaml.sh | 171 | ||||
-rw-r--r-- | htmldoc/themes/material/partials/footer.html | 57 |
3 files changed, 261 insertions, 0 deletions
diff --git a/htmldoc/buildhtml.sh b/htmldoc/buildhtml.sh new file mode 100755 index 00000000..8a41f454 --- /dev/null +++ b/htmldoc/buildhtml.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# buildhtml.sh + +# Builds the html static site, using mkdocs +# Assumes that the script is executed from the root netdata folder, by calling htmldoc/buildhtml.sh + +# Copy all netdata .md files to htmldoc/src. Exclude htmldoc itself and also the directory node_modules generated by Netlify +echo "Copying files" +rm -rf htmldoc/src +find . -type d \( -path ./htmldoc -o -path ./node_modules \) -prune -o -name "*.md" -print | cpio -pd htmldoc/src + +# Modify the first line of the main README.md, to enable proper static html generation +sed -i '0,/# netdata /s//# Introducing NetData\n\n/' htmldoc/src/README.md + +echo "Creating mkdocs.yaml" + +# Generate mkdocs.yaml +htmldoc/buildyaml.sh > htmldoc/mkdocs.yml + +echo "Fixing links" + +# Fix links (recursively, all types, executing replacements) +htmldoc/checklinks.sh -rax +if [ $? -eq 1 ] ; then exit 1 ; fi + +echo "Calling mkdocs" + +# Build html docs +mkdocs build --config-file=htmldoc/mkdocs.yml + +echo "Finished" + diff --git a/htmldoc/buildyaml.sh b/htmldoc/buildyaml.sh new file mode 100755 index 00000000..096e4ce5 --- /dev/null +++ b/htmldoc/buildyaml.sh @@ -0,0 +1,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 +" + + + + diff --git a/htmldoc/themes/material/partials/footer.html b/htmldoc/themes/material/partials/footer.html new file mode 100644 index 00000000..ba690f23 --- /dev/null +++ b/htmldoc/themes/material/partials/footer.html @@ -0,0 +1,57 @@ +{% import "partials/language.html" as lang with context %} +<footer class="md-footer"> + {% if page.previous_page or page.next_page %} + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + {% if page.previous_page %} + <a href="{{ page.previous_page.url | url }}" title="{{ page.previous_page.title }}" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + {{ lang.t("footer.previous") }} + </span> + {{ page.previous_page.title }} + </span> + </div> + </a> + {% endif %} + {% if page.next_page %} + <a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title }}" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + {{ lang.t("footer.next") }} + </span> + {{ page.next_page.title }} + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + {% endif %} + </nav> + </div> + {% endif %} + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + {% if config.copyright %} + <div class="md-footer-copyright__highlight"> + {{ config.copyright }} + </div> + {% endif %} + <a href="https://twitter.com/linuxnetdata" rel="nofollow"><img src="https://img.shields.io/twitter/follow/linuxnetdata.svg?style=social&label=New%20-%20stay%20in%20touch%20-%20follow%20netdata%20on%20twitter"></a> + <img src="https://www.google-analytics.com/collect?v=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Ffirehol%2Fnetdata%2Fwiki&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fwiki&_u=MAC%7E&cid=8c51788e-8721-45e3-ae8c-e7c63ba8236b&tid=UA-64295674-3"> + + + </div> + {% block social %} + {% include "partials/social.html" %} + {% endblock %} + </div> + </div> +</footer> |