summaryrefslogtreecommitdiffstats
path: root/docs/generator
diff options
context:
space:
mode:
Diffstat (limited to 'docs/generator')
-rwxr-xr-xdocs/generator/buildhtml.sh106
-rwxr-xr-xdocs/generator/buildyaml.sh289
-rwxr-xr-xdocs/generator/checklinks.sh334
-rw-r--r--docs/generator/custom/css/netdata.css96
-rw-r--r--docs/generator/custom/img/favicon.icobin349 -> 0 bytes
-rw-r--r--docs/generator/custom/img/geography-16.pngbin461 -> 0 bytes
-rw-r--r--docs/generator/custom/javascripts/cookie-consent.js15
-rw-r--r--docs/generator/custom/themes/material/partials/footer.html67
-rw-r--r--docs/generator/custom/themes/material/partials/header.html108
-rw-r--r--docs/generator/requirements.txt2
-rw-r--r--docs/generator/runtime.txt1
11 files changed, 0 insertions, 1018 deletions
diff --git a/docs/generator/buildhtml.sh b/docs/generator/buildhtml.sh
deleted file mode 100755
index dbd303911..000000000
--- a/docs/generator/buildhtml.sh
+++ /dev/null
@@ -1,106 +0,0 @@
-#!/bin/bash
-
-# buildhtml.sh
-
-# Builds the html static site, using mkdocs
-
-set -e
-
-# Assumes that the script is executed either from the htmldoc folder (by netlify), or from the root repo dir (as originally intended)
-currentdir=$(pwd | awk -F '/' '{print $NF}')
-echo "$currentdir"
-if [ "$currentdir" = "generator" ]; then
- cd ../..
-fi
-GENERATOR_DIR="docs/generator"
-SRC_DIR="${GENERATOR_DIR}/src"
-# Fetch go.d.plugin docs
-GO_D_DIR="collectors/go.d.plugin"
-rm -rf ${GO_D_DIR}
-git clone https://github.com/netdata/go.d.plugin.git ${GO_D_DIR}
-
-# Copy all Netdata .md files to docs/generator/src. Exclude htmldoc itself and also the directory node_modules generatord by Netlify
-echo "Copying files"
-rm -rf ${SRC_DIR}
-find . -type d \( -path ./${GENERATOR_DIR} -o -path ./node_modules \) -prune -o -name "*.md" -print | cpio -pd ${SRC_DIR}
-
-# Copy Netdata html resources
-cp -a ./${GENERATOR_DIR}/custom ./${SRC_DIR}/
-
-# Modify the first line of the main README.md, to enable proper static html generation
-echo "Modifying README header"
-sed -i -e '0,/# Netdata /s//# Netdata Documentation\n\n/' ${SRC_DIR}/README.md
-
-# Remove all GA tracking code
-find ${SRC_DIR} -name "*.md" -print0 | xargs -0 sed -i -e 's/\[!\[analytics.*UA-64295674-3)\]()//g'
-
-# Remove specific files that don't belong in the documentation
-declare -a EXCLUDE_LIST=(
- "HISTORICAL_CHANGELOG.md"
- "contrib/sles11/README.md"
-)
-
-for f in "${EXCLUDE_LIST[@]}"; do
- rm "${SRC_DIR}/$f"
-done
-
-echo "Fetching localization project"
-LOC_DIR=${GENERATOR_DIR}/localization
-rm -rf ${LOC_DIR}
-git clone https://github.com/netdata/localization.git ${LOC_DIR}
-
-echo "Preparing directories"
-MKDOCS_CONFIG_FILE="${GENERATOR_DIR}/mkdocs.yml"
-MKDOCS_DIR="doc"
-DOCS_DIR=${GENERATOR_DIR}/${MKDOCS_DIR}
-rm -rf ${DOCS_DIR}
-
-prep_html() {
- lang="${1}"
- echo "Creating ${lang} mkdocs.yaml"
-
- if [ "${lang}" == "en" ] ; then
- SITE_DIR="build"
- else
- SITE_DIR="build/${lang}"
- fi
-
- # Generate mkdocs.yaml
- ${GENERATOR_DIR}/buildyaml.sh ${MKDOCS_DIR} ${SITE_DIR} ${lang}>${MKDOCS_CONFIG_FILE}
-
- echo "Fixing links"
-
- # Fix links (recursively, all types, executing replacements)
- ${GENERATOR_DIR}/checklinks.sh -rax
-
- echo "Calling mkdocs"
-
- # Build html docs
- mkdocs build --config-file="${MKDOCS_CONFIG_FILE}"
-
- # Fix edit buttons for the markdowns that are not on the main Netdata repo
- find "${GENERATOR_DIR}/${SITE_DIR}/${GO_D_DIR}" -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'
- if [ "${lang}" != "en" ] ; then
- find "${GENERATOR_DIR}/${SITE_DIR}" -name "*.html" -print0 | xargs -0 sed -i -e 's/https:\/\/github.com\/netdata\/netdata\/blob\/master\/\S*md/https:\/\/github.com\/netdata\/localization\//g'
- fi
-
- # Replace index.html with DOCUMENTATION/index.html. Since we're moving it up one directory, we need to remove ../ from the links
- echo "Replacing index.html with DOCUMENTATION/index.html"
- sed 's/\.\.\///g' ${GENERATOR_DIR}/${SITE_DIR}/DOCUMENTATION/index.html > ${GENERATOR_DIR}/${SITE_DIR}/index.html
-
-}
-
-for d in "en" $(find ${LOC_DIR} -mindepth 1 -maxdepth 1 -name .git -prune -o -type d -printf '%f ') ; do
- echo "Preparing source for $d"
- cp -r ${SRC_DIR} ${DOCS_DIR}
- if [ "${d}" != "en" ] ; then
- cp -a ${LOC_DIR}/${d}/* ${DOCS_DIR}/
- fi
- prep_html $d
- rm -rf ${DOCS_DIR}
-done
-
-# Remove cloned projects and temp directories
-rm -rf ${GO_D_DIR} ${LOC_DIR} ${DOCS_DIR} ${SRC_DIR}
-
-echo "Finished"
diff --git a/docs/generator/buildyaml.sh b/docs/generator/buildyaml.sh
deleted file mode 100755
index 04d6098fc..000000000
--- a/docs/generator/buildyaml.sh
+++ /dev/null
@@ -1,289 +0,0 @@
-#!/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/getting-started.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
-navpart 3 collectors/slabinfo.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
diff --git a/docs/generator/checklinks.sh b/docs/generator/checklinks.sh
deleted file mode 100755
index a453d8ff2..000000000
--- a/docs/generator/checklinks.sh
+++ /dev/null
@@ -1,334 +0,0 @@
-#!/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"
-MKDOCS_DIR="doc"
-DOCS_DIR=${GENERATOR_DIR}/${MKDOCS_DIR}
-
-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 [ -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
- cd - >/dev/null
- 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
- echo " - ERROR: $f - $rlnk is neither a file or a directory. Giving up!"
- EXITCODE=1
- fi
- cd $DOCS_DIR >/dev/null
- 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' $f"
- fi
-}
-
-
-checklinks () {
- f=$1
- dbg "Checking $f"
- while read -r l ; do
- for word in $l ; do
- if [[ $word =~ .*\]\(([^\(\) ]*)\).* ]] ; then
- lnk=$(echo "${BASH_REMATCH[1]}" | tr -d '<>')
- if [ -z "$lnk" ] ; then continue ; fi
- dbg " $lnk"
- case "$lnk" in
- mailto:* ) dbg " - Mailto link, ignoring" ;;
- https://github.com/netdata/netdata/wiki* )
- dbg " - Wiki Link $lnk"
- if [ "$CHKWIKI" -eq 1 ] ; then echo " - WARNING: $f - $lnk points to the wiki. Please replace it manually" ; fi
- ;;
- https://github.com/netdata/netdata/????/master* )
- echo " - ERROR: $f - $lnk is an absolute link to a Netdata file. Please convert to relative."
- EXITCODE=1
- ;;
- http* )
- dbg " - External link $lnk"
- if [ "$CHKEXTERNAL" -eq 1 ] ; then
- testURL "$lnk"
- if [ $? -eq 1 ] ; then
- echo " - ERROR: $f - $lnk is a broken link"
- EXITCODE=1
- fi
- fi
- ;;
- * )
- dbg " - Relative link $lnk"
- if [ "$CHKRELATIVE" -eq 1 ] ; then ck_netdata_relative "$f" "$lnk" ; fi
- ;;
- esac
- fi
- done
- done < "$f"
-}
-
-TESTURLS=0
-VERBOSE=0
-RECURSIVE=0
-EXECUTE=0
-CHKWIKI=0
-CHKABSOLUTE=0
-CHKEXTERNAL=0
-CHKRELATIVE=0
-while getopts :f:rxuvwbela option
-do
- case "$option" in
- f)
- file=$OPTARG
- ;;
- r)
- RECURSIVE=1
- ;;
- x)
- EXECUTE=1
- ;;
- u)
- TESTURLS=1
- ;;
- v)
- VERBOSE=1
- ;;
- w)
- CHKWIKI=1
- ;;
- b)
- CHKABSOLUTE=1
- ;;
- e)
- CHKEXTERNAL=1
- ;;
- l)
- CHKRELATIVE=1
- ;;
- a)
- CHKWIKI=1
- CHKABSOLUTE=1
- CHKEXTERNAL=1
- CHKRELATIVE=1
- ;;
- *)
- printhelp
- exit 1
- ;;
- esac
-done
-
-EXITCODE=0
-
-if [ -z "${file}" ] ; then
- if [ $RECURSIVE -eq 0 ] ; then
- printhelp
- exit 1
- fi
- cd ${DOCS_DIR}
- for f in $(find . -type d \( -path ./${GENERATOR_DIR} -o -path ./node_modules \) -prune -o -name "*.md" -print); do
- checklinks "$f"
- done
- cd -
-else
- if [ $RECURSIVE -eq 1 ] ; then
- printhelp
- exit 1
- fi
- checklinks "$file"
-fi
-
-exit $EXITCODE
diff --git a/docs/generator/custom/css/netdata.css b/docs/generator/custom/css/netdata.css
deleted file mode 100644
index 7b1934db4..000000000
--- a/docs/generator/custom/css/netdata.css
+++ /dev/null
@@ -1,96 +0,0 @@
-.md-nav__link {
- white-space: nowrap;
-}
-
-.md-typeset {
- font-size: .75rem
-}
-
-/* Underline text */
-
-.md-typeset a:not(.nav-button):not(.md-icon):not(.headerlink) {
- border-bottom: 1px solid #272b30;
-}
-
-/* Custom styling for the new documentation homepage.
- In particular, the three buttons for install/getting started/configuration. */
-.homepage-nav {
- display: flex;
- margin-top: 1.4rem;
-}
-
-.homepage-nav div {
- flex: 1;
-}
-
-.homepage-nav .nav-install {
- margin-right: 1rem;
-}
-
-.homepage-nav .nav-configuration {
- margin-left: 1rem;
-}
-
-.nav-button {
- border: 2px solid black;
- border-radius: 4px;
- display: block;
- font-weight: 700;
- margin: 0 auto;
- padding: 0.6rem 0;
- text-align: center;
-}
-
-/* Hide the label at the top of the navigation menu. Does nothing.
- Well, it does do something on mobile, and this media query makes
- sure it's hidden only on screens wide enough to not use the mobile sidebar. */
-@media only screen and (min-width:76.25em) {
- .md-nav--primary .md-nav__title {
- display: none;
- }
-}
-
-/* Change the language selector dropdown to match new color. */
-.md-header-nav select#sel {
- background-color: rgba(0,0,0,.26) !important;
- padding: 3px;
- margin-left: 5px;
- margin-right: 20px;
-}
-
-/* Add some whitespace to the bottom of each doc. */
-.md-content {
- margin-bottom: 6rem;
-}
-
-/* Make sure inline code in tables don't break. */
-.md-typeset__table code {
- word-break: normal;
-}
-
-/* Give code blocks a little more line height */
-.md-typeset pre {
- line-height: 1.6;
-}
-
-/* Show line numbers. */
-[data-linenos]:before {
- border-right: .0625rem solid #ddd;
- color: #999;
- content: attr(data-linenos);
- display: inline-block;
- margin-left: -1.2rem;
- margin-right: .7rem;
- padding-left: 1.2rem;
-}
-
-.md-typeset .highlight .hll {
- display: inline;
- margin: 0;
- padding: 0;
-}
-
-/* Bold the first item on the docs sidebar: Netdata Documentation */
-.md-nav--primary > .md-nav__list > .md-nav__item:first-of-type {
- font-weight: 700;
-} \ No newline at end of file
diff --git a/docs/generator/custom/img/favicon.ico b/docs/generator/custom/img/favicon.ico
deleted file mode 100644
index 703716cd0..000000000
--- a/docs/generator/custom/img/favicon.ico
+++ /dev/null
Binary files differ
diff --git a/docs/generator/custom/img/geography-16.png b/docs/generator/custom/img/geography-16.png
deleted file mode 100644
index 48391f958..000000000
--- a/docs/generator/custom/img/geography-16.png
+++ /dev/null
Binary files differ
diff --git a/docs/generator/custom/javascripts/cookie-consent.js b/docs/generator/custom/javascripts/cookie-consent.js
deleted file mode 100644
index a5c65da49..000000000
--- a/docs/generator/custom/javascripts/cookie-consent.js
+++ /dev/null
@@ -1,15 +0,0 @@
-window.addEventListener("load", function(){
-window.cookieconsent.initialise({
- "palette": {
- "popup": {
- "background": "#000"
- },
- "button": {
- "background": "#f1d600"
- }
- },
- "content": {
- "href": "https://docs.netdata.cloud/docs/privacy-policy/"
- }
-})});
-
diff --git a/docs/generator/custom/themes/material/partials/footer.html b/docs/generator/custom/themes/material/partials/footer.html
deleted file mode 100644
index 0631a3042..000000000
--- a/docs/generator/custom/themes/material/partials/footer.html
+++ /dev/null
@@ -1,67 +0,0 @@
-{% 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 }} | <a href="/docs/privacy-policy/">Privacy Policy</a> | <a href="/docs/terms-of-use/">Terms of Use</a>
- </div>
- {% endif %}
- </div>
- {% block social %}
- {% include "partials/social.html" %}
- {% endblock %}
- </div>
- </div>
-</footer>
-<script>!function(e,a,t,n,o,c,i){e.GoogleAnalyticsObject=o,e.ga=e.ga||function(){(e.ga.q=e.ga.q||[]).push(arguments)},e.ga.l=1*new Date,c=a.createElement(t),i=a.getElementsByTagName(t)[0],c.async=1,c.src="https://www.google-analytics.com/analytics.js",i.parentNode.insertBefore(c,i)}(window,document,"script",0,"ga"),ga("create","UA-64295674-3",""),ga("set","anonymizeIp",!0),ga("send","pageview","/doc"+window.location.pathname);var links=document.getElementsByTagName("a");if(Array.prototype.map.call(links,function(a){a.host!=document.location.host&&a.addEventListener("click",function(){var e=a.getAttribute("data-md-action")||"follow";ga("send","event","outbound",e,a.href)})}),document.forms.search){var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})}</script>
-<script>
- let currentLang = getLanguage();
-
- let sel = document.getElementById('sel');
- let opts = sel.options;
- for (let opt, j = 0; opt = opts[j]; j++) {
- if (opt.value == currentLang) {
- sel.selectedIndex = j;
- break;
- }
- }
-
-</script>
diff --git a/docs/generator/custom/themes/material/partials/header.html b/docs/generator/custom/themes/material/partials/header.html
deleted file mode 100644
index 85f874905..000000000
--- a/docs/generator/custom/themes/material/partials/header.html
+++ /dev/null
@@ -1,108 +0,0 @@
-<header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-header-nav__button md-logo">
- {% if config.theme.logo.icon %}
- <i class="md-icon">{{ config.theme.logo.icon }}</i>
- {% else %}
- <img src="{{ config.theme.logo | url }}" width="24" height="24">
- {% endif %}
- </a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
- {% block site_name %}
- {% if config.site_name == page.title %}
- {{ config.site_name }}
- {% else %}
- <span class="md-header-nav__topic">
- {{ config.site_name }}
- </span>
- <span class="md-header-nav__topic">
- {{ page.title }}
- </span>
- {% endif %}
- {% endblock %}
- </div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- {% block search_box %}
- {% if "search" in config["plugins"] %}
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
- {% include "partials/search.html" %}
- {% endif %}
- {% endblock %}
- </div>
-
- <!-- netdata -->
- <style>
- .language-selector li {
- list-style: none;
- }
-
- .language-option.selected {
- background-color: #ccc;
- }
- </style>
- <script>
- function getLanguage() {
- const lang = window.location.pathname.split("/")[1];
-
- if (lang.length == 0 || lang.length > 2) {
- return "en";
- }
-
- return lang;
- }
-
- function languagePrefix(lang) {
- if (lang === "en") {
- return "";
- }
-
- return `/${lang}`;
- }
-
- function updatePathname(pathname, lang) {
- if (currentLang !== "en") {
- const parts = pathname.split("/");
- parts.shift();
- parts.shift();
- pathname = `/${parts.join("/")}`;
- }
-
- return `${languagePrefix(lang)}${pathname}`;
- }
-
- function setLanguage(sel) {
- if (sel.value === currentLang) {
- return;
- }
-
- window.location.pathname = updatePathname(window.location.pathname, sel.value);
- }
- </script>
-
- <div style="vertical-align: middle; white-space: nowrap; padding-left: 20px;" class="md-flex__cell md-flex__cell--shrink">
- <img src="/custom/img/geography-16.png" style="vertical-align: middle;"/>
- <select id="sel" onchange="setLanguage(this);" style="vertical-align: middle; background-color: #3f51b5; color: white; border: none;">
- <option href="#" value='en'>English</option>
- <option href="#" value='zh'>中文</option>
- <option href="#" value='pt'>Portugues-Brasil</option>
- </select>
- </div>
-
- {% if config.repo_url %}
- <div class="md-flex__cell md-flex__cell--shrink">
- <div class="md-header-nav__source">
- {% include "partials/source.html" %}
- </div>
- </div>
- {% endif %}
- </div>
- </nav>
-</header>
diff --git a/docs/generator/requirements.txt b/docs/generator/requirements.txt
deleted file mode 100644
index ac01be7ae..000000000
--- a/docs/generator/requirements.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-mkdocs>=1.0.1
-mkdocs-material
diff --git a/docs/generator/runtime.txt b/docs/generator/runtime.txt
deleted file mode 100644
index d70c8f8d8..000000000
--- a/docs/generator/runtime.txt
+++ /dev/null
@@ -1 +0,0 @@
-3.6
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-07 21:47:29 +0000