Htmldoc (#4607)

* 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

1 files changed, 43 insertions, 0 deletions

diff --git a/web/api/health/README.md b/web/api/health/README.md
new file mode 100644
index 0000000000..9bab960b1d
--- /dev/null
+++ b/web/api/health/README.md
@@ -0,0 +1,43 @@
+# Health API Calls
+
+## Enabled Alarms
+
+NetData enables alarms on demand, i.e. when the chart they should be linked to starts collecting data. So, although many more alarms are configured, only the useful ones are enabled.
+
+To get the list of all enabled alarms:
+
+`http://your.netdata.ip:19999/api/v1/alarms?all`
+
+## Raised Alarms
+
+This API call will return the alarms currently in WARNING or CRITICAL state.
+
+`http://your.netdata.ip:19999/api/v1/alarms`
+
+## Event Log
+
+The size of the alarm log is configured in `netdata.conf`. There are 2 settings: the rotation of the alarm log file and the in memory size of the alarm log.
+
+```
+[health]
+	health db file = /var/lib/netdata/health/health-log.db
+	in memory max health log entries = 1000
+	rotate log every lines = 2000
+```
+
+The API call retrieves all entries of the alarm log:
+
+`http://your.netdata.ip:19999/api/v1/alarm_log`
+
+## Alarm Log Incremental Updates
+
+`http://your.netdata.ip:19999/api/v1/alarm_log?after=UNIQUEID`
+
+The above returns all the events in the alarm log that occurred after UNIQUEID (you poll it once without `after=`, remember the last UNIQUEID of the returned set, which you give back to get incrementally the next events).
+
+## Alarm badges
+
+The following will return an SVG badge of the alarm named `NAME`, attached to the chart named `CHART`.
+
+`http://your.netdata.ip:19999/api/v1/badge.svg?alarm=NAME&chart=CHART`
+