ENH: add a documentation link to the bot documentation

This commit add a link to the bot settings page on
intelmq.readthedocs.org with an anchor to the specific module.

Closes #257

Author: Birger Schacht

CHANGELOG.md

@@ -18,6 +18,7 @@ CHANGELOG
 #### Landing page
 
 #### Configuration
+- Add a link pointing to the module documentation to the settings overlay of every bot (PR#256)
 
 #### Management
 

intelmq_manager/static/js/configs.js

@@ -26,6 +26,7 @@ class VisModel {
 var app = new VisModel();
 
 var popup = null;
+var documentation = null;
 var span = null;
 var table = null;
 var disabledKeys = ['group', 'name', 'module'];
@@ -78,6 +79,7 @@ function load_html_elements() {
         allowDrop(event);
     });
     popup = document.getElementById("network-popUp");
+    documentation = document.getElementById("documentationButton");
     span = document.getElementById('network-popUp-title');
     table = document.getElementById("network-popUp-fields");
 }
@@ -373,6 +375,9 @@ function fill_bot(id, group, name) {
         insertKeyValue(key, bot.defaults[key], BORDER_TYPES.DEFAULT, false);
     }
 
+    const periodpos = bot['module'].lastIndexOf('.');
+    modulename = bot['module'].substring(0, periodpos).replace(/\./g, "-").replace(/_/g, "-");
+    documentation.href = "https://intelmq.readthedocs.org/en/maintenance/user/bots.html#" + modulename;
     popup.setAttribute('class', "with-bot");
 }
 

intelmq_manager/templates/configs.mako

@@ -22,7 +22,10 @@
 </div>
 
 <div id="network-popUp" class="without-bot">
-    <span id="network-popUp-title">node</span> <br>
+    <span id="network-popUp-title">node</span>
+    <a id="documentationButton" class="btn btn-default" title="open documentation" href="">
+	<span class="glyphicon glyphicon-question-sign"></span>
+    </a>
     <table id="network-popUp-fields" class="table table-striped" style="margin:auto;">
         <tr>
             <td>id</td><td><input id="node-id" value="new value"></td>