(SIMP-6886) Add REFERENCE.md (#21)

SIMP-6886 #close

CHANGELOG

@@ -1,4 +1,7 @@
-* Thu Jun 06 2019 Steven Pritchard <steven.pritchard@onyxpoint.com> -0.1.0-0
+* Tue Jul 23 2019 Chris Tessmer <chris.tessmer@onyxpoint.com> - 0.1.0-0
+- Add REFERENCE.md for Puppet Forge
+
+* Thu Jun 06 2019 Steven Pritchard <steven.pritchard@onyxpoint.com> - 0.1.0-0
 - Add v2 compliance_markup data
 - Add support for puppetlabs-stdlib 6
 

README.md

@@ -33,7 +33,6 @@ This module is optimally designed for use within a larger SIMP ecosystem, but it
 
 ## Setup
 
-
 Include the class to use it:
 
 ``` ruby
@@ -45,16 +44,16 @@ class { 'issue':
 ## Reference
 
 Available issue files are:
-  * default
-  * lite
-  * us_doc
-  * us_doc_lite
-  * us_dod
-  * us_noaa
+  * `default`
+  * `lite`
+  * `us_doc`
+  * `us_doc_lite`
+  * `us_dod`
+  * `us_noaa`
 
 They can be read in entirety in the `files/issue` directory.
 
-Please refer to the inline documentation within each source file, or to the module's generated YARD documentation for reference material.
+For further documentation, see [REFERENCE.md](https://github.com/simp/pupmod-simp-issue/blob/master/REFERENCE.md)
 
 
 ## Limitations
@@ -64,4 +63,4 @@ SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux a
 
 ## Development
 
-Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html).
+Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).

REFERENCE.md

@@ -0,0 +1,83 @@
+# Reference
+<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
+
+## Table of Contents
+
+**Classes**
+
+* [`issue`](#issue): Manage /etc/issue and /etc/issue.net
+
+## Classes
+
+### issue
+
+Manage /etc/issue and /etc/issue.net
+
+#### Parameters
+
+The following parameters are available in the `issue` class.
+
+##### `profile`
+
+Data type: `String`
+
+A pre-included banner that can be used out of the box.
+
+Will be overridden by `$content` and/or `$net_content`
+
+Valid values are defined by the `simp_banners` module but the local module
+has the following mappings for legacy support
+  * default      => Standard, we watch everything
+    * New Option => 'simp'
+  * lite         => We only watch for bad things
+    * New Option => 'simp_lite'
+  * us_doc       => U.S. Department of Commerce
+    * New Option => 'us/department_of_commerce'
+  * us_doc_lite  => U.S. Department of Commerce lite
+    * New Option => 'us/department_of_commerce_lite'
+  * us_dod       => U.S. Department of Defense (STIG Compat)
+    * New Option => 'us/department_of_defense'
+  * us_noaa      => U.S. National Oceanic and Atmospehric
+                    Administration
+    * New Option => 'us/national_oceanic_and_atmospheric_administration'
+
+Default value: 'default'
+
+##### `content`
+
+Data type: `Optional[String]`
+
+Defaults to a stock `/etc/issue` file in the module. Provide a custom
+string or file reference to customize. Follows the `File` resource
+`content` parameter syntax.
+
+Default value: `undef`
+
+##### `source`
+
+Data type: `Optional[Pattern[/^puppet:/, /^file:/, /^http:/]]`
+
+Provide a file resource pointer that can be used to set the source of
+the file to use for a banner. Cannot be set with $content. Follows the
+`File` resource `source` parameter syntax.
+
+Default value: `undef`
+
+##### `net_link`
+
+Data type: `Boolean`
+
+If set, links `/etc/issue.net` to `/etc/issue`
+
+Default value: `true`
+
+##### `net_content`
+
+Data type: `Optional[String]`
+
+If `$net_link` is `false`, this content will be written to the
+`/etc/issue.net` file on the system. Follows the `File` resource `content`
+parameter syntax.
+
+Default value: `undef`
+