Merge pull request #353 from sbadia/markdown-flavored

Use markdown syntax on agent and billing documentation

doc/Agent.md

@@ -5,25 +5,32 @@ To gather data from remote systems you can use LibreNMS in combination with chec
 
 On each of the hosts you would like to use the agent on then you need to do the following:
 
- - Copy the check_mk_agent script into /usr/bin/ and make it executable.
+* Copy the `check_mk_agent` script into `/usr/bin` and make it executable.
 
+```shell
 cp scripts/check_mk_agent /usr/bin/check_mk_agent
 chmod +x /usr/bin/check_mk_agent
+```
 
- - Copy the xinetd config file into place.
+* Copy the xinetd config file into place.
 
+```shell
 cp scripts/check_mk_xinetd /etc/xinetd.d/check_mk
+```
 
- - Make the relevant directories.
+* Create the relevant directories.
 
+```shell
 mkdir -p /usr/lib/check_mk_agent/plugins /usr/lib/check_mk_agent/local
+```
 
- - Copy each of the scripts from scripts/agent-local/ into /usr/lib/check_mk_agent/local
+* Copy each of the scripts from `scripts/agent-local/` into `/usr/lib/check_mk_agent/local`
-
+* And restart xinetd.
- - Now restart xinetd.
 
+```shell
 /etc/init.d/xinetd restart
+```
 
- - Login to the LibreNMS web interface and edit the device you want to monitor. Under the modules section, ensure that unix-agent is enabled.
+* Login to the LibreNMS web interface and edit the device you want to monitor. Under the modules section, ensure that unix-agent is enabled.
- - Then under Applications, enable the apps that you plan to monitor.
+* Then under Applications, enable the apps that you plan to monitor.
- - Wait, in around 10 minutes you should start seeing data in your graphs under Apps for the device.
+* Wait, in around 10 minutes you should start seeing data in your graphs under Apps for the device.

doc/Billing_Module.md

@@ -1,10 +1,18 @@
+# Billing Module
+
 To enable and use the billing module you need to perform the following steps:
 
-Edit config.php and add (or enable) the following line near the end of the config
+Edit `config.php` and add (or enable) the following line near the end of the config
-   $config['enable_billing'] = 1; # Enable Billing
 
-Edit /etc/cron.d/librenms and add the following:
+```php
+$config['enable_billing'] = 1; # Enable Billing
+```
+
+Edit `/etc/cron.d/librenms` and add the following:
+
+```bash
 */5 * * * * root /opt/librenms/poll-billing.php >> /dev/null 2>&1
 01  * * * * root /opt/librenms/billing-calculate.php >> /dev/null 2>&1
+```
 
 Create billing graphs as required.

doc/DEVEL.md

@@ -9,7 +9,7 @@ that has LibreNMS already running on it!
 To get started, you can just copy the script from `/contrib/dev_init`,
 or you can enter the following commands into your shell:
 
-```
+```bash
 mkdir -p dev/librenms && cd $_
 curl -O http://wkennedy.co/uploads/librenms/Vagrantfile
 curl -O http://wkennedy.co/uploads/librenms/bootstrap.sh

doc/INSTALL.md

@@ -14,6 +14,7 @@ Input the MySQL root password to enter the MySQL command-line interface.
 
 Create the database:
 
+```sql
 CREATE DATABASE librenms;
 GRANT ALL PRIVILEGES ON librenms.*
   TO 'librenms'@'<ip>'
@@ -21,6 +22,7 @@ Create the database:
 ;
 FLUSH PRIVILEGES;
 exit
+```
 
 Replace `<ip>` above with the IP or DNS name of the server running LibreNMS.  If your database is on the same server as LibreNMS, you can use `localhost`.
 
@@ -85,6 +87,7 @@ First, create and chown the `rrd` directory and create the `logs` directory:
 
 Next, add the following to `/etc/apache2/sites-available/librenms.conf`:
 
+```apache
 <VirtualHost *:80>
   DocumentRoot /opt/librenms/html/
   ServerName  librenms.example.com
@@ -96,6 +99,7 @@ Next, add the following to `/etc/apache2/sites-available/librenms.conf`:
     Options FollowSymLinks MultiViews
   </Directory>
 </VirtualHost>
+```
 
 If you are running Apache 2.2.18 or higher then change AllowEncodedSlashes to NoDecode
 

doc/INSTALL_LIGHTTPD.md

@@ -11,6 +11,7 @@ Enter the MySQL root password to enter the MySQL command-line interface.
 
 Create database.
 
+```sql
 CREATE DATABASE librenms;
 GRANT ALL PRIVILEGES ON librenms.*
   TO 'librenms'@'<ip>'
@@ -18,6 +19,7 @@ Create database.
 ;
 FLUSH PRIVILEGES;
 exit
+```
 
 Replace `<ip>` above with the IP of the server running LibreNMS.  If your database is on the same server as LibreNMS, you can just use `localhost` as the IP address.
 
@@ -145,6 +147,3 @@ LibreNMS performs daily updates by default.  At 00:15 system time every day, a `
 so that it looks like this:
 
     $config['update'] = 0;
-
-
-

doc/INSTALL_RHEL.md

@@ -16,6 +16,7 @@ Enter the MySQL root password to enter the MySQL command-line interface.
 
 Create database.
 
+```sql
 CREATE DATABASE librenms;
 GRANT ALL PRIVILEGES ON librenms.*
   TO 'librenms'@'<ip>'
@@ -23,6 +24,7 @@ Create database.
 ;
 FLUSH PRIVILEGES;
 exit
+```
 
 Replace `<ip>` above with the IP of the server running LibreNMS.  If your database is on the same server as LibreNMS, you can just use `localhost` as the IP address.
 
@@ -57,6 +59,7 @@ Set `httpd` to start on system boot.
 
 Next, add the following to `/etc/httpd/conf.d/librenms.conf`
 
+```apache
 <VirtualHost *:80>
   DocumentRoot /opt/librenms/html/
   ServerName  librenms.example.com
@@ -68,6 +71,7 @@ Next, add the following to `/etc/httpd/conf.d/librenms.conf`
     Options FollowSymLinks MultiViews
   </Directory>
 </VirtualHost>
+```
 
 If you are running Apache 2.2.18 or higher then change `AllowEncodedSlashes` to `NoDecode`
 
@@ -87,6 +91,7 @@ Modify permissions and configuration for `php-fpm` to use nginx credentials.
 
 Add configuration for `nginx` at `/etc/nginx/conf.d/librenms` with the following content:
 
+```nginx
 server {
  listen      80;
  server_name librenms.example.com;
@@ -110,6 +115,7 @@ Add configuration for `nginx` at `/etc/nginx/conf.d/librenms` with the following
   rewrite ^(.+)$ /index.php/$1 last;
  }
 }
+```
 
 ### Cloning ###