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, 17 insertions, 3 deletions

diff --git a/collectors/node.d.plugin/README.md b/collectors/node.d.plugin/README.md
index dd977017d9..fe85fbe4ce 100644
--- a/collectors/node.d.plugin/README.md
+++ b/collectors/node.d.plugin/README.md
@@ -9,7 +9,21 @@
 5. Allows each **module** to have one or more data collection **jobs**
 6. Each **job** is collecting one or more metrics from a single data source
 
-# Motivation
+## Pull Request Checklist for Node.js Plugins
+
+This is a generic checklist for submitting a new Node.js plugin for Netdata.  It is by no means comprehensive.
+
+At minimum, to be buildable and testable, the PR needs to include:
+
+* The module itself, following proper naming conventions: `node.d/<module_dir>/<module_name>.node.js`
+* A README.md file for the plugin. 
+* The configuration file for the module
+* A basic configuration for the plugin in the appropriate global config file: `conf.d/node.d.conf`, which is also in JSON format.  If the module should be enabled by default, add a section for it in the `modules` dictionary.
+* A line for the plugin in the appropriate `Makefile.am` file: `node.d/Makefile.am` under `dist_node_DATA`.
+* A line for the plugin configuration file in `conf.d/Makefile.am`: under `dist_nodeconfig_DATA`
+* Optionally, chart information in `web/dashboard_info.js`.  This generally involves specifying a name and icon for the section, and may include descriptions for the section or individual charts.
+
+## Motivation
 
 Node.js is perfect for asynchronous operations. It is very fast and quite common (actually the whole web is based on it).
 Since data collection is not a CPU intensive task, node.js is an ideal solution for it.
@@ -31,7 +45,7 @@ For more information check the **[[Installation]]** guide.
 ## configuring `node.d.plugin`
 
 `node.d.plugin` can work even without any configuration. Its default configuration file is
-[/etc/netdata/node.d.conf](node.d.conf) (to edit it on your system run `/etc/netdata/edit-config node.d.conf`).
+[/etc/netdata/node.d.conf](https://github.com/netdata/netdata/tree/master/collectors/node.d.plugin/node.d.conf) (to edit it on your system run `/etc/netdata/edit-config node.d.conf`).
 
 ## configuring `node.d.plugin` modules
 
@@ -215,4 +229,4 @@ The `service` object defines a set of functions to allow you send information to
 ---
 
 *FIXME: document an operational node.d.plugin data collector - the best example is the
-[snmp collector](snmp/snmp.node.js)*
+[snmp collector](https://github.com/netdata/netdata/tree/master/collectors/node.d.plugin/snmp/snmp.node.js)*