Merge pull request #420 from rwaffen/update_readme

Update Readme, fix CI Badge, Links, Code Block formats, add Reference…

README.md

@@ -1,20 +1,20 @@
 # JIRA module for Puppet
 
-[![Build Status](https://travis-ci.org/voxpupuli/puppet-jira.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-jira)
+[![CI](https://github.com/voxpupuli/puppet-jira/actions/workflows/ci.yml/badge.svg)](https://github.com/voxpupuli/puppet-jira/actions/workflows/ci.yml)
 [![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-jira/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-jira)
 [![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/jira.svg)](https://forge.puppetlabs.com/puppet/jira)
 [![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/jira.svg)](https://forge.puppetlabs.com/puppet/jira)
 [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/jira.svg)](https://forge.puppetlabs.com/puppet/jira)
 [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/jira.svg)](https://forge.puppetlabs.com/puppet/jira)
 
-#### Table of Contents
+## Table of Contents
 
 1. [Overview](#overview)
 2. [Module Description - What the module does and why it is useful](#module-description)
 3. [Setup - The basics of getting started with JIRA](#setup)
-    * [JIRA Prerequisites](#JIRA-prerequisites)
-    * [What JIRA affects](#what-JIRA-affects)
-    * [Beginning with JIRA](#beginning-with-JIRA)
+    * [JIRA Prerequisites](#jira-prerequisites)
+    * [What JIRA affects](#what-jira-affects)
+    * [Beginning with JIRA](#beginning-with-jira)
     * [Upgrades](#upgrades)
 4. [Usage - Configuration options and additional functionality](#usage)
 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
@@ -247,6 +247,10 @@ Reverse proxy can be configured as a hash as part of the JIRA resource
    },
 ```
 
+## Reference
+
+see [REFERENCE.md](REFERENCE.md)
+
 ## Limitations
 
 * Puppet 6.1.0
@@ -274,18 +278,20 @@ Please feel free to raise any issues here for bug fixes. We also welcome feature
 requests. Feel free to make a pull request for anything and we make the effort to
 review and merge. We prefer with tests if possible.
 
-## Testing - How to test the JIRA module
+## Testing
+
+### How to test the JIRA module
 
 Using [puppetlabs_spec_helper](https://github.com/puppetlabs/puppetlabs_spec_helper).
 Simply run:
 
-```
+```shell
 bundle install && bundle exec rake spec
 ```
 
 to get results.
 
-```
+```shell
 ruby -S rspec spec/classes/jira_install_spec.rb --color
 .
 
@@ -298,7 +304,7 @@ Using [Beaker - Puppet Labs cloud enabled acceptance testing tool.](https://gith
 The beaker tests will install oracle Java to /opt/java. When running the beaker
 tests you agree that you accept the [oracle java license](http://www.oracle.com/technetwork/java/javase/terms/license/index.html).
 
-```
+```shell
 bundle install
 BEAKER_set=ubuntu-server-12042-x64 bundle exec rake beaker
 BEAKER_set=ubuntu-server-1404-x64 bundle exec rake beaker
@@ -311,7 +317,7 @@ BEAKER_set=centos-64-x64-pe bundle exec rake beaker
 To save build time it is useful to host the installation files locally on a web
 server. You can use the download_url environment variable to overwrite the default.
 
-```bash
+```shell
 export download_url="'http://my.local.server/'"
 ```