Improve Markdown syntax in Document (librenms#12949)

* Use GitLab instead of Gitlab

Only change text part, the Alert.Transport.Gitlab class left as is.

* Fix href in document

* Move section in document

The agent list in this document is sorted by alphabetical order,
"SDFS info" is the only exception.

* Remove trailing spaces in document

* Align code in document

* Fix Markdown in document

- Escape underline
- Add syntax highlight
- Add two space in the end of line to make it a newline
- Add newline before list or code section

* Update LibreNMS/Alert/Transport/Gitlab.php

Co-authored-by: Jellyfrog <[email protected]>

Author: Sea-n

LibreNMS/Alert/Transport/Gitlab.php

@@ -14,7 +14,7 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>. */
 
 /**
- * Gitlab API Transport
+ * GitLab API Transport
  * @author Drew Hynes <[email protected]>
  * @copyright 2018 Drew Hynes, LibreNMS
  * @license GPL
@@ -74,11 +74,11 @@ public function contactGitlab($obj, $opts)
             $code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
             if ($code == 200) {
                 $gitlabout = json_decode($ret, true);
-                d_echo('Created Gitlab issue ' . $gitlabout['key'] . ' for ' . $device);
+                d_echo('Created GitLab issue ' . $gitlabout['key'] . ' for ' . $device);
 
                 return true;
             } else {
-                d_echo('Gitlab connection error: ' . serialize($ret));
+                d_echo('GitLab connection error: ' . serialize($ret));
 
                 return false;
             }
@@ -92,13 +92,13 @@ public static function configTemplate()
                 [
                     'title' => 'Host',
                     'name' => 'gitlab-host',
-                    'descr' => 'Gitlab Host',
+                    'descr' => 'GitLab Host',
                     'type' => 'text',
                 ],
                 [
                     'title' => 'Project ID',
                     'name' => 'gitlab-id',
-                    'descr' => 'Gitlab Prokect ID',
+                    'descr' => 'GitLab Project ID',
                     'type'=> 'text',
                 ],
                 [

doc/API/Devices.md

@@ -1310,7 +1310,7 @@ search all oxidized device configs for a string.
 Route: `api/v0/oxidized/config/search/:searchstring`
 
   - searchstring is the specific string you would like to search for.
-  
+
 Input:
 
 -
@@ -1345,7 +1345,7 @@ Returns a specific device's config from oxidized.
 Route: `api/v0/oxidized/config/:device_name`
 
   - device_name is the full dns name of the device used when adding the device to librenms.
-  
+
 Input:
 
 -

doc/API/Inventory.md

@@ -11,7 +11,7 @@ cage, then the sfp itself. The way this API call is designed is to
 enable a recursive lookup. The first call will retrieve the root
 entry, included within this response will be entPhysicalIndex, you can
 then call for entPhysicalContainedIn which will then return the next
-layer of results.  To retrieve all items together, see 
+layer of results.  To retrieve all items together, see
 [get_inventory_for_device](#get_inventory_for_device).
 
 Route: `/api/v0/inventory/:hostname`
@@ -69,8 +69,8 @@ Output:
 
 ### `get_inventory_for_device`
 
-Retrieve the flattened inventory for a device.  This retrieves all 
-inventory items for a device regardless of their structure, and may be 
+Retrieve the flattened inventory for a device.  This retrieves all
+inventory items for a device regardless of their structure, and may be
 more useful for devices with with nested components.
 
 Route: `/api/v0/inventory/:hostname/all`
@@ -114,4 +114,4 @@ Output:
         }
     ]
 }
-```
+```

doc/Alerting/Transports.md

@@ -261,11 +261,11 @@ The index pattern uses strftime() formatting.
 | Port | 9200 |
 | Index Patter | librenms-%Y.%m.%d |
 
-## Gitlab
+## GitLab
 
 LibreNMS will create issues for warning and critical level alerts
 however only title and description are set. Uses Personal access
-tokens to authenticate with Gitlab and will store the token in cleartext.
+tokens to authenticate with GitLab and will store the token in cleartext.
 
 **Example:**
 
@@ -359,9 +359,9 @@ As a small reminder, here is it's configuration directives including defaults:
 ## Matrix
 
 For using the Matrix transports, you have to create a room on the Matrix-server.
-The provided Auth_token belongs to an user, which is member of this room. 
+The provided Auth_token belongs to an user, which is member of this room.
 The Message, sent to the matrix-room can be built from the variables defined in
-[Template-Syntax](Templates.md#syntax) but without the 'alert->' prefix. 
+[Template-Syntax](Templates.md#syntax) but without the 'alert->' prefix.
 See API-Transport. The variable ``` $msg ``` is contains the result of the Alert template.
 The Matrix-Server URL is cutted before the beginning of the ``_matrix/client/r0/...`` API-part.
 
@@ -376,9 +376,9 @@ The Matrix-Server URL is cutted before the beginning of the ``_matrix/client/r0/
 
 ## Microsoft Teams
 
-LibreNMS can send alerts to Microsoft Teams [Incoming Webhooks](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) which are 
-then posted to a specific channel. Microsoft recommends using 
-[markdown](https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format#markdown-formatting-for-connector-cards) formatting for connector cards. 
+LibreNMS can send alerts to Microsoft Teams [Incoming Webhooks](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) which are
+then posted to a specific channel. Microsoft recommends using
+[markdown](https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format#markdown-formatting-for-connector-cards) formatting for connector cards.
 Administrators can opt to [compose](https://messagecardplayground.azurewebsites.net/)
 the [MessageCard](https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference)
 themselves using JSON to get the full functionality.
@@ -658,7 +658,10 @@ You need a token you can find on your personnal space.
 LibreNMS can send alerts to a Splunk instance and provide all device
 and alert details.
 
-Example output: `Feb 21 15:21:52 nms  hostname="localhost", sysName="localhost", 
+Example output:
+
+```
+Feb 21 15:21:52 nms  hostname="localhost", sysName="localhost", 
 sysDescr="", sysContact="", os="fortigate", type="firewall", ip="localhost", 
 hardware="FGT_50E", version="v5.6.9", serial="", features="", location="", 
 uptime="387", uptime_short=" 6m 27s", uptime_long=" 6 minutes 27 seconds", 

doc/Developing/Creating-Documentation.md

@@ -1,4 +1,4 @@
-source: Developing/Creating-Documentation.md  
+source: Developing/Creating-Documentation.md
 path: blob/master/doc/
 
 # Creating Documentation
@@ -63,13 +63,13 @@ This means you can use:
 
 ## Building docs
 
-This is achieved with `mkdocs`, a python package. 
+This is achieved with `mkdocs`, a python package.
 
-1. Install the required packages. 
+1. Install the required packages.
 
 ```
 pip install mkdocs mkdocs-exclude mkdocs-material mkdocs-macros-plugin
-``` 
+```
 If you encounter permissions issues, these might be reoslved by using the
 user option, with whatever user you are building as, e.g. `-u librenms`
 
@@ -92,9 +92,9 @@ This will output all the documentation in html format to `/opt/librenms/out`
 
 ## Viewing docs
 
-mkdocs includes it's own light-weight webserver for this purpose. 
+mkdocs includes it's own light-weight webserver for this purpose.
 
-Viewing is as simple as running the following command: 
+Viewing is as simple as running the following command:
 
 ```
 $ mkdocs serve
@@ -105,7 +105,7 @@ INFO    -  Documentation built in 12.54 seconds
 INFO    -  Serving on http://127.0.0.1:8000
 <..>
 INFO    -  Start watching changes
-``` 
+```
 
 Now you will find the complete set of LibreNMS documentation by opening your
 browser to `localhost:8000`.

doc/Developing/Dynamic-Config.md

@@ -16,7 +16,7 @@ If the user is overriding the option in config.php it would use the format `$con
 
 ## Translation
 
-The config definition system inherently supports translation. You must add the English names in the 
+The config definition system inherently supports translation. You must add the English names in the
 `resoures/lang/en/settings.php` file (and other languages if you can).
 
 To update the javascript translation files, run:

doc/Developing/os/Health-Information.md

@@ -142,7 +142,7 @@ case the oid is indexed multiple times) are also available: if
 $index="1.20", then $subindex0="1" and $subindex1="20".
 
 When referencing an oid in another table the full index will be used to match the other table.
-If this is undesirable, you may use a single sub index by appending the sub index after a colon to 
+If this is undesirable, you may use a single sub index by appending the sub index after a colon to
 the variable name.  Example `{{ $ifName:2 }}`
 
 > `skip_values` can also compare items within the OID table against
@@ -214,7 +214,7 @@ the discovery code in php.
 The directory structure for sensor information is
 `includes/discovery/sensors/$class/$os.inc.php`. The format of all of
 the sensors follows the same code format which is to collect sensor information
-via SNMP and then call the `discover_sensor()` function; with the exception of state 
+via SNMP and then call the `discover_sensor()` function; with the exception of state
 sensors which requires additional code. Sensor information is commonly found in an ENTITY
 mib supplied by device's vendor in the form of a table. Other mib tables may be used as
 well. Sensor information is first collected by
@@ -324,7 +324,7 @@ line walks the cmEntityObject table to get information about the chassis and lin
 this information we extract the model type which will identify which tables in the CM-Facility-Mib
 the ports are populated in. The program then reads the appropriate table into the `$pre_cache`
 array `adva_fsp150_ports`. This array will have OID indexies for each port, which we will use
-later to identify our sensor OIDs. 
+later to identify our sensor OIDs.
 
 ```
 $pre_cache['adva_fsp150'] = snmpwalk_cache_multi_oid($device, 'cmEntityObjects', [], 'CM-ENTITY-MIB', null, '-OQUbs');

doc/Developing/os/Mem-CPU-Information.md

@@ -12,7 +12,7 @@ To detect non-standard MIBs, they can be defined via Yaml.
 ##### YAML
 
 In order to successfully detect memory amount and usage, two of the for keys below are required.  Some OS only
-provide a usage percentage, which will work, but a total RAM amount will not be displayed. 
+provide a usage percentage, which will work, but a total RAM amount will not be displayed.
 
 - total
 - used
@@ -36,7 +36,7 @@ including {{ }} parsing, skip_values, and precache.
 Valid data entry keys:
 
 - `oid` oid to walk to collect processor data
-- `total` oid or integer total memory size in bytes (or precision), 
+- `total` oid or integer total memory size in bytes (or precision)
 - `used` oid memory used in bytes (or precision)
 - `free` oid memory free in bytes (or precision)
 - `percent_used` oid of percentage of used memory

doc/Extensions/Agent-Setup.md

@@ -82,6 +82,6 @@ If you want to restrict which network adapter the agent listens on, do the follo
 
 
 ## Windows
-1. Grab version 1.2.6b5 of the check_mk agent from the check_mk github repo (exe/msi or compile it yourself depending on your usage): https://github.com/tribe29/checkmk/tree/v1.2.6b5/agents/windows
+1. Grab version 1.2.6b5 of the check_mk agent from the check_mk github repo (exe/msi or compile it yourself depending on your usage): <https://github.com/tribe29/checkmk/tree/v1.2.6b5/agents/windows>
 2. Run the msi / exe
 3. Make sure your LibreNMS instance can reach TCP port 6556 on your target.

doc/Extensions/Applications.md

@@ -113,7 +113,7 @@ by following the steps under the `SNMP Extend` heading.
 1. [NTP Client](#ntp-client) - SNMP extend
 1. [NTP Server/NTPD](#ntp-server-aka-ntpd) - SNMP extend
 1. [Nvidia GPU](#nvidia-gpu) - SNMP extend
-1. [Open Grid Scheduler](#opengridscheduler) - SNMP extend
+1. [Open Grid Scheduler](#open-grid-scheduler) - SNMP extend
 1. [Opensips](#opensips) - SNMP extend
 1. [OS Updates](#os-updates) - SNMP extend
 1. [PHP-FPM](#php-fpm) - SNMP extend
@@ -126,7 +126,7 @@ by following the steps under the `SNMP Extend` heading.
 1. [PowerDNS dnsdist](#powerdns-dnsdist) - SNMP extend
 1. [PowerMon](#powermon) - SNMP extend
 1. [Proxmox](#proxmox) - SNMP extend
-1. [Puppet Agent](#puppet_agent) - SNMP extend
+1. [Puppet Agent](#puppet-agent) - SNMP extend
 1. [PureFTPd](#pureftpd) - SNMP extend
 1. [Raspberry PI](#raspberry-pi) - SNMP extend
 1. [Redis](#redis) - SNMP extend
@@ -374,6 +374,7 @@ via `wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/
 A small python3 script that checks age and remaining validity of certificates
 
 This script needs following packages on Debian/Ubuntu Systems:
+
 * python3
 * python3-openssl
 
@@ -495,7 +496,7 @@ wget https://github.com/librenms/librenms-agent/raw/master/snmp/docker-stats.sh
 4: Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
 
 ```
-extend docker /etc/snmp/docker-stats.sh 
+extend docker /etc/snmp/docker-stats.sh
 ```
 
 5: Restart snmpd on your host
@@ -951,7 +952,7 @@ Extend` heading top of page.
 
 To create your own custom munin scripts, please see this example:
 
-```
+```bash
 #!/bin/bash
 if [ "$1" = "config" ]; then
     echo 'graph_title Some title'
@@ -1022,7 +1023,7 @@ Verify it is working by running `/usr/lib/check_mk_agent/local/mysql`
 
 ## SNMP extend
 
-1: Copy the mysql script to the desired host. 
+1: Copy the mysql script to the desired host.
 ```
 wget https://github.com/librenms/librenms-agent/raw/master/snmp/mysql -O /etc/snmp/mysql
 ```
@@ -1053,10 +1054,10 @@ configuration responsible for the localhost server:
 ```text
 location /nginx-status {
     stub_status on;
-    access_log   off;
+    access_log  off;
     allow 127.0.0.1;
     allow ::1;
-    deny all;
+    deny  all;
 }
 ```
 
@@ -1568,7 +1569,7 @@ script which method to use. The are several options to assist with testing, see
 
 ### Initial setup
 
-1. Download the python script onto the host: 
+1. Download the python script onto the host:
 ```
 wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/powermon-snmp.py -O /usr/local/bin/powermon-snmp.py
 ```
@@ -1866,6 +1867,33 @@ SNMP extend script to monitor your (remote) RRDCached via snmp
 extend rrdcached /etc/snmp/rrdcached
 ```
 
+# SDFS info
+
+A small shell script that exportfs SDFS volume info.
+
+## SNMP Extend
+
+1: Download the script onto the desired host (the host must be added
+   to LibreNMS devices)
+
+```
+wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/sdfsinfo -O /etc/snmp/sdfsinfo
+```
+
+2: Make the script executable (chmod +x /etc/snmp/sdfsinfo)
+
+3: Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
+
+```
+extend sdfsinfo /etc/snmp/sdfsinfo
+```
+
+4: Restart snmpd on your host
+
+The application should be auto-discovered as described at the top of
+the page. If it is not, please follow the steps set out under `SNMP
+Extend` heading top of page.
+
 # Seafile
 
 SNMP extend script to monitor your Seafile Server
@@ -2108,7 +2136,7 @@ The application should be auto-discovered as described at the top of
 the page. If it is not, please follow the steps set out under `SNMP
 Extend` heading top of page.
 
-# Option 2: Agent
+## Option 2: Agent
 
 [Install the agent](#agent-setup) on this device if it isn't already
 and copy the `unbound.sh` script to `/usr/lib/check_mk_agent/local/`
@@ -2168,33 +2196,6 @@ The application should be auto-discovered as described at the top of
 the page. If it is not, please follow the steps set out under `SNMP
 Extend` heading top of page.
 
-# SDFS info
-
-A small shell script that exportfs SDFS volume info.
-
-## SNMP Extend
-
-1: Download the script onto the desired host (the host must be added
-   to LibreNMS devices)
-
-```
-wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/sdfsinfo -O /etc/snmp/sdfsinfo
-```
-
-2: Make the script executable (chmod +x /etc/snmp/sdfsinfo)
-
-3: Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
-
-```
-extend sdfsinfo /etc/snmp/sdfsinfo
-```
-
-4: Restart snmpd on your host
-
-The application should be auto-discovered as described at the top of
-the page. If it is not, please follow the steps set out under `SNMP
-Extend` heading top of page.
-
 # Voip-monitor
 
 Shell script that reports cpu-load/memory/open-files files stats of Voip Monitor