docs: More doc updates (#4365)

* More doc updates

* Updated to add update

* added tune option

doc/Developing/Creating-Documentation.md

@@ -3,16 +3,35 @@ source: Developing/Creating-Documentation.md
 
 One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation.
 
+### Writing docs
 When you are adding a new feature or extension, we need to have full documentation to go along with it. It's quite 
 simple to do this:
 
   - Find the relevant directory to store your new document in, General, Support and Extensions are the most likely choices.
   - Think of a descriptive name that's not too long, it should match what they may be looking for or describes the feature.
+  - Ensure the first line contains: `source: path/to/file.md` - don't include the intial `doc/`.
   - In the body of the document, be descriptive but keep things simple. Some tips:
     - If the document could cover different distros like CentOS and Ubuntu please try and include the information for them all.
       If that's not possible then at least put a placeholder in asking for contributions.
     - Ensure you use the correct formating for `commands` and `code blocks` by wrapping one liners in backticks or blocks in ```.
+    - Put content into sub-headings where possible to organise the content.
   - If you rename a file, please add a redirect in for the old file by using `<meta http-equiv="refresh" content="0; url=/NewLocation/" />` within the old file name.
 
 Please ensure you add the document to the relevant section within `pages` of `mkdocs.yml` so that it's in the correct menu and is built.
 Forgetting this step will result in your document never seeing the light of day :)
+
+### Formatting docs
+Our docs are based on Markdown using mkdocs which adheres to markdown specs and nothing more, because of that we also import a 
+couple of extra libraries:
+
+  - pymdownx.tasklist
+  - mdx_del_ins
+
+This means you can use:
+
+  - `~~strikethrough~~` to perform ~~strikethrough~~
+  - [X] `- [X] List items` 
+  - Url's can be made `[like this](http://www.librenms.org)` [like this](http://www.librenms.org)
+  - Code can be placed in `` for single line or ``` for multiline.
+  - `#` Can be used for main headings which translates to a `<h1>` tag, increasing the `#`'s will increase the hX tags.
+  - `###` Can be used for sub-headings which will appear in the TOC to the left.

doc/Developing/Creating-Release.md

@@ -1,4 +1,4 @@
-Developing/Creating-Release.md
+source: Developing/Creating-Release.md
 # Creating a release
 
 ### GitHub

doc/Developing/Merging-Pull-Requests.md

@@ -1,4 +1,4 @@
-Developing/Merging-Pull-Requests.md
+source: Developing/Merging-Pull-Requests.md
 # Merging Pull Requests
 
 ### GitHub

doc/Extensions/Alerting.md

@@ -130,6 +130,8 @@ Placeholders:
 - Transport name: `%transport`
 - Contacts, must be iterated in a foreach, `%key` holds email and `%value` holds name: `%contacts`
 
+Placeholders can be used within the subjects for templates as well although %faults is most likely going to be worthless.
+
 > NOTE: Placeholder names which are contained within another need to be ordered correctly. As an example:
 
 ```text
@@ -188,18 +190,17 @@ By default the Contacts will be only gathered when the alert triggers and will i
 The contacts will always include the `SysContact` defined in the Device's SNMP configuration and also every LibreNMS-User that has at least `read`-permissions on the entity that is to be alerted.
 At the moment LibreNMS only supports Port or Device permissions.
 You can exclude the `SysContact` by setting:
-~~
+
 ```php
 $config['alert']['syscontact'] = false;
 ```
-~
+
 To include users that have `Global-Read` or `Administrator` permissions it is required to add these additions to the `config.php` respectively:
-~
+
 ```php
 $config['alert']['globals'] = true; //Include Global-Read into alert-contacts
 $config['alert']['admins']  = true; //Include Administrators into alert-contacts
 ```
-~~
 
 ## <a name="transports-email">E-Mail</a>
 

doc/Extensions/Distributed-Poller.md

@@ -63,7 +63,7 @@ Memcache is required for the distributed pollers to be able to register to a cen
 Pollers can be installed and run from anywhere, the only requirements are:
 
 They can access the Memcache instance
-They can create RRD files via some method such as a shared filesystem
+They can create RRD files via some method such as a shared filesystem or RRDTool >=1.5.5
 They can access the MySQL server
 
 You can either assign pollers into groups and set a poller group against certain devices, this will mean that those devices will only be processed by certain pollers (default poller group is 0) or you can assign all pollers to the default poller group for them to process any and all devices.

doc/Extensions/RRDCached.md

@@ -11,6 +11,27 @@ To enable this set the following config:
 $config['rrdtool_version'] = 1.5.5;
 ```
 
+### Support matrix
+
+Shared FS: Is a shared filesystem required?
+
+Features: Supported features in the version indicated.
+
+          G = Graphs.
+
+          C = Create RRD files.
+
+          U = Update RRD files.
+
+          T = Tune RRD files.
+
+| Version | Shared FS | Features |
+| ------- | :-------: | -------- |
+| 1.4.x   | Yes       | G,U      |
+| <1.5.5  | Yes       | G,U      |
+| >=1.5.5 | No        | G,C,U    |
+| >=1.6.x | No        | G,C,U    |
+
 ### RRDCached installation CentOS 6
 This example is based on a fresh LibreNMS install, on a minimal CentOS 6 installation.
 In this example, we'll use the Repoforge repository.

mkdocs.yml

@@ -4,7 +4,8 @@ theme_dir: 'librenms_theme'
 site_dir: out
 site_url: http://docs.librenms.org
 markdown_extensions:
-    - pymdownx.superfences
+    - pymdownx.tasklist
+    - mdx_del_ins
 extra_css:
     - librenms.css
 include_next_prev: false

scripts/deploy-docs.sh

@@ -5,6 +5,7 @@ THEME_REPO="https://github.com/librenms-docs/librenms_theme.git"
 
 pip install --user mkdocs
 pip install --user pymdown-extensions
+pip install --user git+git://github.com/aleray/mdx_del_ins.git
 
 mkdir -p out