Merge pull request voxpupuli#172 from vinzent/doc_update

Update inline doc to puppet-strings
EmRowlands · Jan 13, 2017 · d977da9 · d977da9
2 parents e67037e + eb27be1
commit d977da9
Show file tree

Hide file tree

Showing 41 changed files with 5,624 additions and 188 deletions.
diff --git a/.yardopts b/.yardopts
@@ -1 +1,2 @@
 --markup markdown
+--output-dir docs/
diff --git a/Gemfile b/Gemfile
@@ -26,6 +26,7 @@ group :test do
   gem 'puppet-blacksmith',                                          :require => false
   gem 'voxpupuli-release',                                          :require => false, :git => 'https://github.com/voxpupuli/voxpupuli-release-gem.git'
   gem 'puppet-strings', '~> 1.0.0',                                 :require => false
+  gem 'redcarpet',                                                  :require => false
   gem 'rubocop-rspec', '~> 1.9.0',                                  :require => false if RUBY_VERSION >= '2.3.0'
   gem 'mocha', '>= 1.2.1',                                          :require => false
   gem 'coveralls',                                                  :require => false

diff --git a/README.md b/README.md
@@ -37,14 +37,6 @@ running system.
 * Mailinglist: <voxpupuli@groups.io> 
   ([groups.io Webinterface](https://groups.io/g/voxpupuli/topics))
 
-## Usage
-
-Parameters:
-
-* `$mode` (enforced|permissive|disabled) - sets the operating state for SELinux.
-* `$type` (targeted|minimum|mls) - sets the enforcement type.
-* `$manage_package` (boolean) - Whether or not to manage the SELinux management package.
-* `$package_name` (string) - sets the name of the selinux management package.
 
 ## Known problems / limitations
 
@@ -65,6 +57,14 @@ Parameters:
 * `selinux::permissive` allows only to set a domain to permissive but not to
    remove it. (GH-165)
 
+## Usage
+
+There is puppet-strings generated documentation available in the docs/ folder 
+of the github repo.
+
+It will be available at http://voxpupuli.org/pupppet-selinux some time in 
+the future.
+
 ## Reference
 
 ### Basic usage

diff --git a/docs/_index.html b/docs/_index.html
@@ -0,0 +1,191 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Documentation by YARD 0.9.7
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = null;
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="puppet_class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="puppet_class_list_link"
+        href="puppet_class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.7</h1>
+<div id="listing">
+  <h1 class="alphaindex">Alphabetic Index</h1>
+
+<h2>Puppet Class Listing A-Z</h2>
+
+
+<table>
+  <tr>
+    <td valign='top' width="33%">
+
+
+      <ul id="alpha_S" class="alpha">
+        <li class="letter">S</li>
+          <ul>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux.html" title="puppet_classes::selinux (puppet_class)">selinux</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Aconfig.html" title="puppet_classes::selinux::config (puppet_class)">selinux::config</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Apackage.html" title="puppet_classes::selinux::package (puppet_class)">selinux::package</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Aparams.html" title="puppet_classes::selinux::params (puppet_class)">selinux::params</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond.html" title="puppet_classes::selinux::restorecond (puppet_class)">selinux::restorecond</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond_3A_3Aconfig.html" title="puppet_classes::selinux::restorecond::config (puppet_class)">selinux::restorecond::config</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond_3A_3Aservice.html" title="puppet_classes::selinux::restorecond::service (puppet_class)">selinux::restorecond::service</a></span>
+
+            </li>
+
+      </ul>
+    </ul>
+
+    </td>
+  </tr>
+</table>
+
+
+<h2>Defined Type Listing A-Z</h2>
+
+
+<table>
+  <tr>
+    <td valign='top' width="33%">
+
+
+      <ul id="alpha_S" class="alpha">
+        <li class="letter">S</li>
+          <ul>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Aboolean.html" title="puppet_defined_types::selinux::boolean (puppet_defined_type)">selinux::boolean</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Afcontext.html" title="puppet_defined_types::selinux::fcontext (puppet_defined_type)">selinux::fcontext</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Amodule.html" title="puppet_defined_types::selinux::module (puppet_defined_type)">selinux::module</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Apermissive.html" title="puppet_defined_types::selinux::permissive (puppet_defined_type)">selinux::permissive</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Aport.html" title="puppet_defined_types::selinux::port (puppet_defined_type)">selinux::port</a></span>
+
+            </li>
+
+            <li>
+      <span class='object_link'><a href="puppet_defined_types/selinux_3A_3Arestorecond_3A_3Afragment.html" title="puppet_defined_types::selinux::restorecond::fragment (puppet_defined_type)">selinux::restorecond::fragment</a></span>
+
+            </li>
+
+      </ul>
+    </ul>
+
+    </td>
+  </tr>
+</table>
+
+
+
+
+
+  <h2>File Listing</h2>
+  <ul id="files" class="index_inline_list">
+
+
+    <li class="r1"><a href="index.html" title="README">README</a></li>
+
+
+  </ul>
+
+<div class="clear"></div>
+
+
+</div>
+
+</div>
+
+      <div id="footer">
+  Generated on Fri Jan 13 15:43:22 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.7 (ruby-2.3.3).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/docs/css/common.css b/docs/css/common.css
@@ -0,0 +1,8 @@
+/* Ensure the search bar doesn't overlap with links */
+.fixed_header {
+  padding-bottom: 25px;
+}
+
+#full_list {
+  padding-top: 15px;
+}
diff --git a/docs/css/full_list.css b/docs/css/full_list.css
@@ -0,0 +1,58 @@
+body {
+  margin: 0;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-size: 13px;
+  height: 101%;
+  overflow-x: hidden;
+  background: #fafafa;
+}
+
+h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
+.clear { clear: both; }
+.fixed_header { position: fixed; background: #fff; width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; height: 70px; }
+#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
+#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
+#full_list { padding: 0; list-style: none; margin-left: 0; margin-top: 80px; font-size: 1.1em; }
+#full_list ul { padding: 0; }
+#full_list li { padding: 0; margin: 0; list-style: none; }
+#full_list li .item { padding: 5px 5px 5px 12px; }
+#noresults { padding: 7px 12px; background: #fff; }
+#content.insearch #noresults { margin-left: 7px; }
+li.collapsed ul { display: none; }
+li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
+li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
+li { color: #888; cursor: pointer; }
+li.deprecated { text-decoration: line-through; font-style: italic; }
+li.odd { background: #f0f0f0; }
+li.even { background: #fafafa; }
+.item:hover { background: #ddd; }
+li small:before { content: "("; }
+li small:after { content: ")"; }
+li small.search_info { display: none; }
+a, a:visited { text-decoration: none; color: #05a; }
+li.clicked > .item { background: #05a; color: #ccc; }
+li.clicked > .item a, li.clicked > .item a:visited { color: #eee; }
+li.clicked > .item a.toggle { opacity: 0.5; background-position: bottom right; }
+li.collapsed.clicked a.toggle { background-position: top right; }
+#search input { border: 1px solid #bbb; border-radius: 3px; }
+#full_list_nav { margin-left: 10px; font-size: 0.9em; display: block; color: #aaa; }
+#full_list_nav a, #nav a:visited { color: #358; }
+#full_list_nav a:hover { background: transparent; color: #5af; }
+#full_list_nav span:after { content: ' | '; }
+#full_list_nav span:last-child:after { content: ''; }
+
+#content h1 { margin-top: 0; }
+li { white-space: nowrap; cursor: normal; }
+li small { display: block; font-size: 0.8em; }
+li small:before { content: ""; }
+li small:after { content: ""; }
+li small.search_info { display: none; }
+#search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
+#content.insearch #search { background-position: center right; }
+#search input { width: 110px; }
+
+#full_list.insearch ul { display: block; }
+#full_list.insearch .item { display: none; }
+#full_list.insearch .found { display: block; padding-left: 11px !important; }
+#full_list.insearch li a.toggle { display: none; }
+#full_list.insearch li small.search_info { display: block; }