plugins/mcollective/pluginpackager/templates/module/README.md.erb

   1 # <%= @package_name %>
   2
   3 #### Table of Contents
   4
   5 1. [Overview](#overview)
   6 2. [Module Description - What the module does and why it is useful](#module-description)
   7 3. [Setup - The basics of getting started with <%= @package_name %>](#setup)
   8     * [What the <%= @package_name %> module affects](#what-the-<%= @package_name %>-module-affects)
   9     * [Setup requirements](#setup-requirements)
  10 4. [Usage - Configuration options and additional functionality](#usage)
  11 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  12
  13
  14 ## Overview
  15
  16 The <%= @package_name %> module is a module that wraps a source release of the
  17 <%= @plugin.metadata[:name] %> mcollective plugin for use with the
  18 [puppetlabs mcollective](http://forge.puppetlabs.com/puppetlabs/mcollective)
  19 module.
  20
  21 ## Module description
  22
  23 ## Usage
  24
  25 <% @plugin.packagedata.keys.map { |x| x.to_s }.sort.each do |klass| -%>
  26 <%# Don't document common class -%>
  27 <% if klass != "common" -%>
  28 ### class <%= @package_name %>::<%= klass %>
  29
  30 Installs the <%= klass %> component of the <%= @plugin.metadata[:name] %> plugin.
  31
  32 ```puppet
  33 include <%= @package_name%>::<%= klass %>
  34 ```
  35 <% end %>
  36 <% end %>
  37