0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-22 12:32:32 +00:00
netdata_netdata/htmldoc/buildhtml.sh
Chris Akritidis 3aae8f6c2c Htmldoc ()
* First html documentation debug set

* Test 2

* Relative path changed

* Updated comments

* Cleanup, installation draft added

* fixes

* test

* test

* test

* First html documentation debug set

* Test 2

* Relative path changed

* Updated comments

* Cleanup, installation draft added

* fixes

* test

* test

* test

* First set of major cleanup/deduplication

* 2nd major cleanup

* update getting started structure

* Cleanup in using netdata

* Final cleanup/deduplication

* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators

* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md

* First html documentation debug set

* Updated Makefile.am to ignore the new md and htmldoc generation files

* Removing files from rebase

* First html documentation debug set

* Test 2

* Relative path changed

* Updated comments

* Cleanup, installation draft added

* fixes

* test

* test

* test

* First html documentation debug set

* Test 2

* Relative path changed

* Updated comments

* Cleanup, installation draft added

* test

* test

* First set of major cleanup/deduplication

* 2nd major cleanup

* update getting started structure

* Cleanup in using netdata

* Final cleanup/deduplication

* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators

* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md

* First html documentation debug set

* Updated Makefile.am to ignore the new md and htmldoc generation files

* Removing files from rebase

* Fixed Makefile.am

* Same line header and badges

* Fixed broken link

* CPU monitoring is in apps plugin

* Removed obsolete files

* Remove obsolete files

* - Make the Health API part of health/README.md new file web/api/health/README.md
- Make installer/LAUNCH.md part of deamon/README.md
- Move installer/MAINTAINERS.md to packaging/maintainers/README.md
- Move installer/DOCKER.md to docker/README.md
- Move system/README.md to daemon/config/README.md
- Move web/CUSTOM-DASHBOARDS.md to web/gui/custom/README.md
- Move web/CONFLUENCE-DASHBOARDS.md to web/gui/confluence/README.md

* Resolve codacy issue $(..) syntax instead of `..`

* Fix following warnings and add svgs to the data_structures/README.md
  - CHANGELOG.md
  - CODE_OF_CONDUCT.md
  - CONTRIBUTORS.md
  - REDISTRIBUTED.md
  - diagrams/data_structures/README.md
  - docker/README.md
WARNING -  Documentation file 'README.md' contains a link to 'collectors/plugins.d' which does not exist in the documentation directory.
WARNING -  Documentation file 'README.md' contains a link to 'collectors/statsd.plugin' which does not exist in the documentation directory.
WARNING -  Documentation file 'CONTRIBUTING.md' contains a link to 'web/CUSTOM-DASHBOARDS.md' which does not exist in the documentation directory.
WARNING -  Documentation file 'CONTRIBUTING.md' contains a link to 'web/CONFLUENCE-DASHBOARDS.md' which does not exist in the documentation directory.

* Wrong urls in data_structures/README.md svgs

* Fix svg URLs number 2

* Modify the first line of the main README.md, to enable proper static html generation. Executed after copying the file to htmldoc/src

* Added back Why Netdata

* Fixed link to registry in Why-Netdata.md

* Added Why-Netdata to buildyaml and to Makefile.am

* Replaced http links causing mixed content warnings

* Made buildhtml ignore the directory node_modules created by Netlify

* Corrected CONTRIBUTING.MD to CONTRIBUTING.md
2018-11-12 22:34:59 +02:00

21 lines
729 B
Bash
Executable file

#!/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
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
# Generate mkdocs.yaml
htmldoc/buildyaml.sh > htmldoc/mkdocs.yml
# Build html docs
mkdocs build --config-file=htmldoc/mkdocs.yml