falkorlib 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38bfe617392f042fbe43a3e60b45d33f87b94c88
-  data.tar.gz: 2cb0eb72bca03898d749989e5b2866a903198384
+  metadata.gz: 41cf1812507626ce7b0667e4356fa5b312ff45ab
+  data.tar.gz: 0c25f1428c8a36b9aecfb19be41679883aead93b
 SHA512:
-  metadata.gz: b1aa919917033fe8fd0f9cc6dca58fb7d60bf4da33ae99904e900fc8eaf5ef475ee8fec187e6b41926a585194c450bab65d428dd36aa435fa765b8b93ff3cc98
-  data.tar.gz: a765a716ba617bf32a40f17ead40ae5e322a77d43046b80c15a48b200ad1b76589acea7247206bf6077b0657ca7575bf4757e82c64d7f14cd695ee046594fe7e
+  metadata.gz: 4530b721c14523c1eb99db1db0b40a09fbb9991f2518206f1b4f93be908d5d63196cb705aa32761624f38ab2a7756b7b31d0c333191fcc42acf4267e12dfae49
+  data.tar.gz: 67355b7d06502993823aa49b597bcf4ef10571b2bce3f52a161bde77dd9dc346566d8ec35cf2fbe854484d4f6164029f6022c9ec4b0956ef3e7d7cdb27b1edb7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.5.0)
+    falkorlib (0.5.1)
       artii (>= 2.1)
       awesome_print (~> 1.2)
       configatron (~> 3.2)

data/lib/falkorlib/puppet/modules.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Fri 2015-05-08 16:33 svarrette>
+# Time-stamp: <Fri 2015-05-15 23:24 svarrette>
 ################################################################################
 # Interface for the main Puppet Module operations
 #
@@ -24,7 +24,7 @@ module FalkorLib  #:nodoc:
                         :version      => '0.0.1',
                         :author       => "#{ENV['GIT_AUTHOR_NAME']}",
                         :mail         => "#{ENV['GIT_AUTHOR_EMAIL']}",
-                        :summary      => "rtfm",
+                        :summary      => "Configure and manage rtfm",
                         :description  => '',
                         :license      => 'Apache-2.0',
                         :source       => '',
@@ -89,7 +89,8 @@ module FalkorLib  #:nodoc:
                 config = {}
                 #login = `whoami`.chomp
                 config[:name] = name unless name.empty?
-                moduledir = name.empty? ? rootdir : File.join(rootdir, name)
+                moduledir     = rootdir
+                  #name.empty? ? rootdir : File.join(rootdir, name)
                 FalkorLib::Config::Puppet::Modules::DEFAULTS[:metadata].each do |k,v|
                     next if v.kind_of?(Array) or k == :license
                     next if k == :name and ! name.empty?
@@ -111,8 +112,9 @@ module FalkorLib  #:nodoc:
                                      end
                     config[k.to_sym] = ask( "\t" + sprintf("%-20s", "Module #{k}"), default_answer)
                 end
-                config[:shortname] = name = config[:name].gsub(/.*-/, '')
-                tags = ask("\tKeywords (comma-separated list of tags)", name)
+                config[:shortname] = name = config[:name].gsub(/.*[-\/]/, '')
+                config[:docs_project] = ask("\tRead the Docs (RTFD) project:", config[:name].downcase.gsub(/\//,'-puppet-'))
+                tags = ask("\tKeywords (comma-separated list of tags)", config[:shortname])
                 config[:tags] = tags.split(',')
                 list_license    = FalkorLib::Config::Puppet::Modules::DEFAULTS[:licenses]
                 default_license = FalkorLib::Config::Puppet::Modules::DEFAULTS[:metadata][:license]
@@ -144,7 +146,8 @@ module FalkorLib  #:nodoc:
                     newname = e.gsub(/templatename/, "#{name}")
                     run %{ mv #{e} #{newname} }
                 end
-
+                # Update docs directory
+                run %{ ln -s ../README.md #{moduledir}/docs/overview.md }
                 info "Generating the License file"
                 authors = config[:author].empty? ? 'UNKNOWN' : config[:author]
                 Dir.chdir(moduledir) do
@@ -167,7 +170,7 @@ module FalkorLib  #:nodoc:
                         FalkorLib::GitFlow.start('feature', "bootstrapping", moduledir)
                     end
                     [ 'metadata.json',
-                     'doc/', 'LICENSE', '.gitignore', '.ruby-version', '.ruby-gemset',
+                     'docs/', 'LICENSE', '.gitignore', '.ruby-version', '.ruby-gemset',
                      'Gemfile', '.vagrant_init.rb', 'Rakefile', 'Vagrantfile' ].each do |f|
                         FalkorLib::Git.add(File.join(moduledir, f))
                     end
@@ -184,8 +187,9 @@ module FalkorLib  #:nodoc:
                       })
                 name = File.basename(moduledir)
                 metadata = metadata(moduledir, {
-                                        :use_symbols => false,
-                                        :extras      => false
+                                        :use_symbols    => false,
+                                        :extras         => false,
+                                        :no_interaction => options[:no_interaction]
                                     })
                 puts "**********************"
                 puts metadata.to_yaml
@@ -240,7 +244,8 @@ module FalkorLib  #:nodoc:
             #
             def metadata(moduledir = Dir.pwd, options = {
                              :use_symbols => true,
-                             :extras      => true
+                             :extras      => true,
+                             :no_interaction => false
                          })
                 add_extras = options[:extras].nil? ? true : options[:extras]
                 name     = File.basename( moduledir )
@@ -249,6 +254,7 @@ module FalkorLib  #:nodoc:
                 error "Unable to find #{jsonfile}" unless File.exist?( jsonfile )
                 metadata = JSON.parse( IO.read( jsonfile ) )
                 if add_extras
+                    metadata["docs_project"] = ask("\tRead the Docs (RTFD) project:", "#{name.downcase.gsub(/\//,'-puppet-')}") if metadata["docs_project"].nil?
                     metadata[:shortname] = name.gsub(/.*-/, '')
                     metadata[:platforms] = []
                     metadata["operatingsystem_support"].each do |e|
@@ -293,7 +299,12 @@ module FalkorLib  #:nodoc:
                 metadata = metadata(moduledir)
                 templatedir = File.join( FalkorLib.templates, 'puppet', 'modules')
                 i = 0
-                update_from_erb = [ 'README.md', 'doc/contributing.md', 'doc/vagrant.md']
+                update_from_erb = [
+                                   'README.md',
+                                   'docs/contacts.md',
+                                   'docs/contributing/index.md', 'docs/contributing/layout.md', 'docs/contributing/setup.md', 'docs/contributing/versioning.md',
+                                   'docs/index.md', 'docs/rtfd.md', 'docs/vagrant.md'
+                                  ]
                 (update_from_erb + [ 'Gemfile', 'Rakefile', 'Vagrantfile', '.vagrant_init.rb' ]).each do |f|
                     next unless options[:exclude].nil? or ! options[:exclude].include?( f )
                     next unless options[:only].nil?    or options[:only].include?(f)
@@ -301,7 +312,7 @@ module FalkorLib  #:nodoc:
                     ans = options[:no_interaction] ? 'Yes' : ask(cyan("==> procceed? (Y|n)"), 'Yes')
                     next if ans =~ /n.*/i
                     if update_from_erb.include?(f)
-                        ap "=> updating #{f}.erb"
+                        puts "=> updating #{f}.erb"
                         i += write_from_erb_template(File.join(templatedir, "#{f}.erb"),
                                                      File.join(moduledir,  f),
                                                      metadata,

data/lib/falkorlib/tasks/puppet_modules.rake

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
 # puppet_modules.rake - Special tasks for the management of Puppet modules
-# Time-stamp: <Fri 2015-05-08 17:06 svarrette>
+# Time-stamp: <Fri 2015-05-15 18:24 svarrette>
 #
 # Copyright (c) 2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
 #               http://varrette.gforge.uni.lu
@@ -24,10 +24,10 @@ namespace :bootstrap do
             name = args.name == 'name' ? ask("Enter the module name") : args.name
             error "You need to provide a module name" unless name != ''
             error "The module name cannot contain spaces" if name =~ /\s+/
-            moduledir = File.join( FalkorLib.config[:puppet][:modulesdir], name)
+            moduledir = File.join( FalkorLib.config[:puppet][:modulesdir], name.gsub(/^\w*\//,'puppet-'))
             dir = ask("Destination directory:", moduledir)
             error "The module '#{name}' already exists" if File.directory?(dir)
-            FalkorLib::Puppet::Modules.init(dir)
+            FalkorLib::Puppet::Modules.init(dir, name)
         end
 
 
@@ -128,14 +128,16 @@ namespace :templates do
 			FalkorLib::Puppet::Modules.upgrade()
 		end 
 
-		[ 'readme', 'rake', 'vagrant' ].each do |t|
+		[ 'docs', 'readme', 'rake', 'vagrant' ].each do |t|
 			###########   templates:upgrade:{readme,rake,vagrant}   ###########
             desc "Upgrade (overwrite) #{t.capitalize} using the current FalkorLib template"
 			task t.to_sym do
 				list = case t
 				       when 'readme'
-					       [ 'README.md', 'doc/contributing.md', 'doc/vagrant.md' ]
-				       when 'rake' 
+					       [ 'README.md' ]
+                       when 'docs'
+                           [ 'contacts.md',  'contributing/index.md', 'contributing/layout.md', 'contributing/setup.md', 'contributing/versioning.md', 'index.md', 'rtfd.md', 'vagrant.md' ]
+                       when 'rake' 
 					       [ 'Gemfile', 'Rakefile' ]
 				       when 'vagrant'
 					       [ 'Vagrantfile', '.vagrant_init.rb']

data/lib/falkorlib/version.rb

@@ -19,7 +19,7 @@ module FalkorLib #:nodoc:
         # MAJOR: Defines the major version
         # MINOR: Defines the minor version
         # PATCH: Defines the patch version
-	    MAJOR, MINOR, PATCH = 0, 5, 0  
+	    MAJOR, MINOR, PATCH = 0, 5, 1  
 	    
 	    module_function
 	    

data/spec/falkorlib/puppet_modules_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # puppet_modules_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Fri 2015-05-08 16:36 svarrette>
+# Time-stamp: <Fri 2015-05-15 23:24 svarrette>
 #
 # @description Check the Puppet Modules operations
 #
@@ -40,7 +40,7 @@ describe FalkorLib::Puppet::Modules do
 
         it "#init -- create a puppet module" do
             # Prepare answer to the questions
-            Array.new(16).each { |e|  STDIN.should_receive(:gets).and_return('') }
+            Array.new(17).each { |e|  STDIN.should_receive(:gets).and_return('') }
             FalkorLib::Puppet::Modules.init(moduledir)
             templatedir = File.join( FalkorLib.templates, 'puppet', 'modules')
             s = true
@@ -52,7 +52,7 @@ describe FalkorLib::Puppet::Modules do
                 filename = File.basename(file)
                 filename = File.basename(file, '.erb') unless file =~ /templates\/toto-variables\.erb/ 
                 f = File.join(moduledir, relative_dir, filename)
-                #puts "checking #{f} - #{File.exists?( f )}"
+                puts "checking #{f} - #{File.exists?( f )}"
                 s &= File.exists?( f )
             end
             s.should be_true
@@ -147,7 +147,7 @@ describe FalkorLib::Puppet::Modules do
 			               ]
 		end
 
-		upgraded_files_default = 2
+		upgraded_files_default = 1
 		it "#upgrade" do
 			d = FalkorLib::Puppet::Modules.upgrade(moduledir, {
 				                                       :no_interaction => true

data/spec/falkorlib/versioning_puppet_module_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # versioning_puppet_module_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Fri 2015-05-08 16:28 svarrette>
+# Time-stamp: <Fri 2015-05-15 23:28 svarrette>
 #
 # @description Check the versioning operations on Gems
 #
@@ -53,7 +53,7 @@ describe FalkorLib::Versioning::Puppet do
 
             ap default_version
             it "#get_version -- get default version #{default_version} after initialization" do
-                Array.new(16).each { |e|  STDIN.should_receive(:gets).and_return('') }
+                Array.new(17).each { |e|  STDIN.should_receive(:gets).and_return('') }
                 FalkorLib::Puppet::Modules.init(moduledir)
                 v = FalkorLib::Versioning.get_version(moduledir)
                 v.should == default_version

data/templates/puppet/modules/README.md.erb

@@ -5,6 +5,7 @@
 [![Puppet Forge](http://img.shields.io/puppetforge/v/<%= config[:name].gsub(/-/,"/") %>.svg)](<%= config[:forge_url] %>)
 [![License](http://img.shields.io/:license-<%= config[:license].gsub(/-/, '') %>-blue.svg)](LICENSE)
 ![Supported Platforms](http://img.shields.io/badge/platform-<%= config[:platforms].join('|') %>-lightgrey.svg)
+[![Documentation Status](https://readthedocs.org/projects/<%= config[:docs_project] %>/badge/?version=latest)](https://readthedocs.org/projects/<%= config[:docs_project] %>/?badge=latest)
 
 <%= config[:summary] %>
 
@@ -12,7 +13,7 @@
       Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
       
 
-* [Online Project Page](<%= config[:project_page] %>)  -- [Sources](<%= config[:source] %>) -- [Issues](<%= config[:issues_url] %>)
+| [Project Page](<%= config[:project_page] %>) | [Sources](<%= config[:source] %>) | [Documentation](httpd://<%= config[:docs_project] %>.readthedocs.org/en/latest/) | [Issues](<%= config[:issues_url] %>) |
 
 ## Synopsis
 
@@ -38,7 +39,7 @@ All these components are configured through a set of variables you will find in
 [`manifests/params.pp`](manifests/params.pp). 
 
 _Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
-See [`doc/contributing.md`](doc/contributing.md) for more details on the steps you shall follow to have this `Rakefile` working properly. 
+See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly. 
 
 ## Dependencies
 
@@ -57,7 +58,7 @@ It accepts the following parameters:
 
 * `$ensure`: default to 'present', can be 'absent'
 
-Use is as follows:
+Use it as follows:
 
      include ' <%= config[:shortname] %>'
 
@@ -66,6 +67,8 @@ See also [`tests/init.pp`](tests/init.pp)
 <% unless config[:classes].nil? %>
 <%    config[:classes].each do |cl| %>
 <%       next if cl == config[:shortname] %>
+<%       next if cl =~ /common/ %>
+<%       next if cl =~ /params/ %>
 ### Class `<%= cl %>`
 
 See [`tests/<%= cl.gsub("#{config[:shortname]}::", "").gsub(/::/, '/') %>.pp`](tests/<%= cl.gsub("#{config[:shortname]}::", "").gsub(/::/, '/') %>.pp)
@@ -105,8 +108,8 @@ You can of course configure the <%= config[:shortname] %> module in your `Puppet
 or, if you prefer to work on the git version: 
 
      mod "<%= config[:name] %>", 
-         :git => <%= config[:source] %>,
-         :ref => <%= FalkorLib.config[:gitflow][:branches][:master] %> 
+         :git => '<%= config[:source] %>',
+         :ref => '<%= FalkorLib.config[:gitflow][:branches][:master] %>' 
 
 ## Issues / Feature request
 
@@ -115,7 +118,7 @@ You can submit bug / issues / feature request using the [<%= config[:name] %> Pu
 ## Developments / Contributing to the code 
 
 If you want to contribute to the code, you shall be aware of the way this module is organized. 
-These elements are detailed on [`doc/contributing.md`](doc/contributing.md)
+These elements are detailed on [`docs/contributing.md`](contributing.md).
 
 You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests). 
 
@@ -124,6 +127,11 @@ You are more than welcome to contribute to its development by [sending a pull re
 The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
 The `Vagrantfile` at the root of the repository pilot the provisioning various vagrant boxes available on [Vagrant cloud](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=virtualbox&q=svarrette) you can use to test this module.
 
-See [`doc/vagrant.md`](doc/vagrant.md) for more details. 
+See [`docs/vagrant.md`](vagrant.md) for more details. 
 
+## Online Documentation
+
+[Read the Docs](https://readthedocs.org/) aka RTFD hosts documentation for the open source community and the [<%= config[:name] %>](<%= config[:projects_url] %>) puppet module has its documentation (see the `docs/` directly) hosted on [readthedocs](http://<%= config[:docs_project] %>.rtfd.org).
+
+See [`docs/rtfd.md`](rtfd.md) for more details.
 

data/templates/puppet/modules/docs/contacts.md.erb

@@ -0,0 +1,10 @@
+This Puppet Module has been implemented in the context of the [UL HPC](http://hpc.uni.lu) Platform of the [University of Luxembourg](http://www.uni.lu).
+More precisely, the [UL HPC Management Team](https://hpc.uni.lu/about/team.html#system-administrators) took care of this development for this module.
+
+You can submit bug / issues / feature request using the [<%= config[:name] %> Puppet Module Tracker](<%= config[:issues_url] %>). 
+Alternatively, you can contact them on the following email address: `hpc-sysadmins@uni.lu`
+
+
+
+
+

data/templates/puppet/modules/docs/contributing/index.md.erb

@@ -0,0 +1,14 @@
+This project is released under the terms of the [<%= config[:license].capitalize %> Licence](LICENSE). 
+So you are more than welcome to contribute to its development as follows: 
+
+1. Fork it
+2. Create your feature branch (`rake git:feature:start[<feature_name>]`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git flow feature publish <feature_name>`)
+5. Create new Pull Request
+
+This assumes that you have understood the [directory tree structure](layout.md) of this Puppet module.
+
+There is also a number of pre-requisite programs / framework you shall install to be able to correctly contribute to this Puppet module. This is detailed in the [Repository Setup and Developments](setup.md) page.
+
+Finally, you shall be aware of the way the [semantic versioning](versioning.md) procedure of this Puppet module are handled.

data/templates/puppet/modules/docs/contributing/layout.md.erb

@@ -0,0 +1,32 @@
+The directory hosting the implementation of this puppet module is organized as follows:
+
+```
+.gitignore              # Git ignore file
+.ruby-{version,gemset}  # [RVM](https://rvm.io/) configuration
+.vagrant_init.rb        # Vagrant provisionner to test this module
+├── Gemfile[.lock]      # [Bundler](http://bundler.io/) configuration
+├── LICENSE             # Licence file
+├── README.md           # This file
+├── Rakefile            # Definition of the [rake](https://github.com/jimweirich/rake) tasks
+├── Vagrantfile         # Pilot Vagrant to test this module
+├── docs/               # [Read the Docs](readthedocs.org) main directory
+├── files/              # (eventually) Contains static files, which managed nodes can download
+├── lib/                # (eventually) Custom facts/type/provider definitions
+├── manifests/         
+│   ├── init.pp         # Main manifests file which defines the sudo class 
+│   ├── common/
+│   │   ├── debian.pp   # Specific Debian setup for the main class
+│   │   └── redhat.pp   # Specific Redhat setup for the main class
+│   ├── common.pp       # Common class setup for all OS
+│   ├── ...             # Implementation of the other <%= config[:shortname] %>::* classes / definitions
+│   └── params.pp       # Class parameters
+├── metadata.json       # Puppet module configuration file -- See http://tinyurl.com/puppet-metadata-json
+├── mkdocs.yml          # [Read the Docs](readthedocs.org) configuration 
+├── pkg/                # Hold build packages to be published on the [Puppet forge](<%= config[:forge_url] %>)
+├── spec/               # (eventually) [Rspec](https://www.relishapp.com/rspec/) tests
+├── templates/          # (eventually) Module ERB template files
+└── tests/              # Tests cases for the module usage
+```
+
+Globally, this module follows the [official PuppetLabs guidelines for the predictable directory tree structure of Puppet modules](http://docs.puppetlabs.com/puppet/latest/reference/modules_fundamentals.html#module-layout).
+

data/templates/puppet/modules/docs/contributing/setup.md.erb

@@ -0,0 +1,53 @@
+There is a number of pre-requisite programs / framework you shall install to be able to correctly contribute to this Puppet module.
+
+### Git Branching Model
+
+The Git branching model for this repository follows the guidelines of [gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
+In particular, the central repository holds two main branches with an infinite lifetime: 
+
+* `<%=  FalkorLib.config[:gitflow][:branches][:master] %>`: the branch holding   tags of the successive releases of this tutorial 
+* `<%= FalkorLib.config[:gitflow][:branches][:develop] %>`: the main branch where the sources are in a state with the latest delivered development changes for the next release. This is the *default* branch you get when you clone the repository, and the one on which developments will take places.
+
+You should therefore install [git-flow](https://github.com/nvie/gitflow), and probably also its associated [bash completion](https://github.com/bobthecow/git-flow-completion).
+
+### Ruby, [RVM](https://rvm.io/) and [Bundler](http://bundler.io/)
+
+The various operations that can be conducted from this repository are piloted
+from a `Rakefile` and assumes you have a running Ruby installation.
+
+The bootstrapping of your repository is based on [RVM](https://rvm.io/), **thus
+ensure this tools are installed on your system** -- see
+[installation notes](https://rvm.io/rvm/install).
+
+The ruby stuff part of this repository corresponds to the following files:
+
+* `.ruby-{version,gemset}`: [RVM](https://rvm.io/) configuration, use the name of the
+  project as [gemset](https://rvm.io/gemsets) name
+* `Gemfile[.lock]`: used by `[bundle](http://bundler.io/)`
+
+### Repository Setup
+
+Then, to make your local copy of the repository ready to use the [git-flow](https://github.com/nvie/gitflow) workflow and the local [RVM](https://rvm.io/)  setup, you have to run the following commands once you cloned it for the first time: 
+
+      $> gem install bundler    # assuming it is not yet available
+	  $> bundle install
+	  $> rake -T                # To list the available tasks
+      $> rake setup 
+
+You probably wants to activate the bash-completion for rake tasks.
+I personnaly use the one provided [here](https://github.com/ai/rake-completion)
+
+Also, some of the tasks are hidden. Run `rake -T -A` to list all of them. 
+
+### RSpec tests
+
+A set of unitary tests are defined to validate the different function of my library using [Rspec](http://rspec.info/) 
+
+You can run these tests by issuing:
+
+	$> rake rspec  # NOT YET IMPLEMENTED
+	
+By conventions, you will find all the currently implemented tests in the `spec/` directory, in files having the `_spec.rb` suffix. This is expected from the `rspec` task of the `Rakefile`.
+
+**Important** Kindly stick to this convention, and feature tests for all   definitions/classes/modules you might want to add. 
+

data/templates/puppet/modules/docs/contributing/versioning.md.erb

@@ -0,0 +1,30 @@
+The operation consisting of releasing a new version of this repository is
+automated by a set of tasks within the `Rakefile`. 
+
+In this context, a version number have the following format:
+
+      <major>.<minor>.<patch>
+
+where:
+
+* `< major >` corresponds to the major version number
+* `< minor >` corresponds to the minor version number
+* `< patch >` corresponds to the patching version number
+
+Example: `1.2.0`
+
+The current version number is stored in the file `metadata.json`. 
+For more information on the version, run:
+
+     $> rake version:info
+
+If a new  version number such be bumped, you simply have to run:
+
+     $> rake version:bump:{major,minor,patch}
+
+This will start the release process for you using `git-flow`.
+Then, to make the release effective, just run:
+
+     $> rake version:release
+
+This will finalize the release using `git-flow`, create the appropriate tag and merge all things the way they should be. 

data/templates/puppet/modules/docs/index.md.erb

@@ -0,0 +1,31 @@
+-*- mode: markdown; mode: visual-line;  -*-
+
+# <%= config[:name] %> Puppet Module 
+
+[![Puppet Forge](http://img.shields.io/puppetforge/v/<%= config[:name].gsub(/-/,"/") %>.svg)](<%= config[:forge_url] %>)
+[![License](http://img.shields.io/:license-<%= config[:license].gsub(/-/, '') %>-blue.svg)](LICENSE)
+![Supported Platforms](http://img.shields.io/badge/platform-<%= config[:platforms].join('|') %>-lightgrey.svg)
+[![Documentation Status](https://readthedocs.org/projects/<%= config[:docs_project] %>/badge/?version=latest)](https://readthedocs.org/projects/<%= config[:docs_project] %>/?badge=latest)
+
+      Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
+
+| [Project Page](<%= config[:project_page] %>) | [Sources](<%= config[:source] %>) | [Documentation](http://<%= config[:docs_project] %>.readthedocs.org/en/latest/) | [Issues](<%= config[:issues_url] %>) |
+
+
+-----------
+The [<%= config[:name] %>](<%= config[:project_page] %>) puppet module has been designed to <%= config[:summary].downcase %>
+
+This is the main page of the documentation for this Puppet module, which is hosted and managed by [Read the Docs](http://<%= config[:name].downcase.gsub(/\//,'-') %>.readthedocs.org/en/latest/).
+It proposes to detail the following elements:
+
+* An [Overview](overview.md) of the module is proposed, describing the puppet classes and/or definitions it implements.
+     - you might also wish to check the `tests/` directory for sample test cases 
+* How to [test this module with Vagrant](vagrant.md)
+* How to [contribute](contributing/index.md) to this puppet module development. In particular, we detail:
+     - the [directory tree structure](contributing/layout.md)
+	 - the steps to follow to [setup this repository](contributing/setup.md)
+	 - information as regard the [semantic versioning](contributing/versioning.md) of this Puppet module. 
+     - Apart form the directory layout, we will cover various configuration aspects ([git-flow](https://github.com/nvie/gitflow), [RVM](https://rvm.io/), [Bundler](http://bundler.io/) etc.)
+* Details on the [Read the Docs](http://<%= config[:name].downcase.gsub(/\//,'-') %>.readthedocs.org/en/latest/) management.
+
+

data/templates/puppet/modules/docs/rtfd.md.erb

@@ -0,0 +1,13 @@
+The documentation for this puppet module is handled by [Read the Docs](https://readthedocs.org/), a web service dedicated to documentation management for the open source community.
+
+* [Reference documentation](https://docs.readthedocs.org/en/latest/)
+
+By default, the [<%= config[:name] %>](<%= config[:project_page] %>) repository is bound to the [<%= config[:docs_project] %>](http://<%= config[:docs_project] %>.rtfd.org) project on Read the Docs (to avoid confusion with other <%= config[:shortname] %> projects). 
+
+You might wish to generate locally the docs:
+
+* Install [`mkdocs`](http://www.mkdocs.org/#installation)
+* Preview your documentation from the project root by running `mkdocs serve` and visite with your favorite browser the URL `http://localhost:8000`
+* build the full documentation locally by running `mkdocs build`
+
+

data/templates/puppet/modules/manifests/common/debian.pp.erb

@@ -4,7 +4,7 @@
 # License::   <%= config[:license].capitalize %>
 #
 # ------------------------------------------------------------------------------
-# = Class: <%= config[:shortname] %>::debian
+# = Class: <%= config[:shortname] %>::common::debian
 #
 # Specialization class for Debian systems
 class <%= config[:shortname] %>::common::debian inherits <%= config[:shortname] %>::common { }

data/templates/puppet/modules/manifests/common/redhat.pp.erb

@@ -4,7 +4,7 @@
 # License::   <%= config[:license].capitalize %>
 #
 # ------------------------------------------------------------------------------
-# = Class: <%= config[:shortname] %>::debian
+# = Class: <%= config[:shortname] %>::common::redhat
 #
-# Specialization class for Debian systems
+# Specialization class for Redhat systems
 class <%= config[:shortname] %>::common::redhat inherits <%= config[:shortname] %>::common { }

data/templates/puppet/modules/metadata.json.erb

@@ -7,6 +7,9 @@
   "description": "<%= config[:description] %>",
   "license": "<%= config[:license] %>",
   "source": "<%= config[:source] %>",
+<% unless config[:docs_project].nil? %>
+  "docs_project": "<%= config[:docs_project] %>",
+<% end %>
   "project_page": "<%= config[:project_page] %>",
   "issues_url": "<%= config[:issues_url] %>",
   "forge_url": "<%= config[:forge_url] %>",

data/templates/puppet/modules/mkdocs.yml.erb

@@ -0,0 +1,12 @@
+site_name: <%= config[:name] %> Puppet Module
+pages:
+- ['index.md', 'Home']
+- ['overview.md', 'Overview']
+- ['vagrant.md', 'Tests with Vagrant']
+- ['contributing/index.md', 'Contributing', 'Overview']
+- ['contributing/layout.md', 'Contributing', 'Directory Layout']
+- ['contributing/setup.md', 'Contributing', 'Repository Setup and Developments']
+- ['contributing/versioning.md', 'Contributing', 'Module Versioning']
+- ['rtfd.md', 'Documentation', 'RTFD']
+- ['contacts.md', 'Contacts']
+theme: readthedocs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -421,8 +421,14 @@ files:
 - templates/puppet/modules/README.md.erb
 - templates/puppet/modules/Rakefile
 - templates/puppet/modules/Vagrantfile
-- templates/puppet/modules/doc/contributing.md.erb
-- templates/puppet/modules/doc/vagrant.md.erb
+- templates/puppet/modules/docs/contacts.md.erb
+- templates/puppet/modules/docs/contributing/index.md.erb
+- templates/puppet/modules/docs/contributing/layout.md.erb
+- templates/puppet/modules/docs/contributing/setup.md.erb
+- templates/puppet/modules/docs/contributing/versioning.md.erb
+- templates/puppet/modules/docs/index.md.erb
+- templates/puppet/modules/docs/rtfd.md.erb
+- templates/puppet/modules/docs/vagrant.md.erb
 - templates/puppet/modules/files/README.md.erb
 - templates/puppet/modules/manifests/common.pp.erb
 - templates/puppet/modules/manifests/common/debian.pp.erb
@@ -431,6 +437,7 @@ files:
 - templates/puppet/modules/manifests/mydef.pp.erb
 - templates/puppet/modules/manifests/params.pp.erb
 - templates/puppet/modules/metadata.json.erb
+- templates/puppet/modules/mkdocs.yml.erb
 - templates/puppet/modules/templates/README.md.erb
 - templates/puppet/modules/templates/templatename-variables.erb
 - templates/puppet/modules/tests/init.pp.erb

data/templates/puppet/modules/doc/contributing.md.erb

@@ -1,132 +0,0 @@
--*- mode: markdown; mode: visual-line; -*-
-
-# <%= config[:shortname].capitalize %> Puppet Module Developments
-
-If you want to contribute to the code, you shall be aware of the way this module is organized.
-
-### Directory Layout
-
-       <%= config[:name] %>/       # Main directory 
-           `-- metadata.json     # Module configuration - cf [here](https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file)
-           `-- README.md         # This file
-           `-- files/            # Contains static files, which managed nodes can download
-           `-- lib/              # custom facts/type/provider definitions
-           `-- manifests/
-                `-- init.pp      # Main manifests file which defines the <%= config[:shortname] %> class 
-                `-- params.pp    # <%= config[:name] %> module variables 
-<% unless config[:classes].nil? %>
-<%     config[:classes].each do |cl| %>
-<%        next if cl =~ /params/ %>
-                `-- <%= cl.gsub("#{config[:shortname]}::", "").gsub(/::/, '/') %>.pp 
-<%     end %>
-<% end %>
-<% unless config[:definitions].nil? %>
-<%     config[:definitions].each do |de| %>
-                `-- <%= de.gsub("#{config[:shortname]}::", "").gsub(/::/, '/') %>.pp 
-<%     end %>
-<% end %>
-           `-- templates/        # Module ERB template files
-           `-- tests/            # Contains examples showing how to declare the module’s classes and defined type
-           `-- spec/             # Contains rspec tests 
-           `-- Rakefile          # Definition of the [rake](https://github.com/jimweirich/rake) tasks
-           `-- .ruby-{version,gemset}   # [RVM](https://rvm.io/) configuration
-           `-- Gemfile[.lock]    # [Bundler](http://bundler.io/) configuration
-           `-- .git/             # Hold git configuration
-           `-- .vagrant_init.rb  # Vagrant provisionner to test this module
-           `-- Vagrantfile       # Vagrant file
-
-### Git Branching Model
-
-The Git branching model for this repository follows the guidelines of [gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
-In particular, the central repository holds two main branches with an infinite lifetime: 
-
-* `<%= FalkorLib.config[:gitflow][:branches][:master] %>`: the branch holding   tags of the successive releases of this tutorial 
-* `<%= FalkorLib.config[:gitflow][:branches][:develop] %>`: the main branch where the sources are in a state with the latest delivered development changes for the next release. This is the *default* branch you get when you clone the repository, and the one on which developments will take places.
-
-You should therefore install [git-flow](https://github.com/nvie/gitflow), and probably also its associated [bash completion](https://github.com/bobthecow/git-flow-completion).  
-
-### Ruby, [RVM](https://rvm.io/) and [Bundler](http://bundler.io/)
-
-The various operations that can be conducted from this repository are piloted
-from a `Rakefile` and assumes you have a running Ruby installation.
-
-The bootstrapping of your repository is based on [RVM](https://rvm.io/), **thus
-ensure this tools are installed on your system** -- see
-[installation notes](https://rvm.io/rvm/install).
-
-The ruby stuff part of this repository corresponds to the following files:
-
-* `.ruby-{version,gemset}`: [RVM](https://rvm.io/) configuration, use the name of the
-  project as [gemset](https://rvm.io/gemsets) name
-* `Gemfile[.lock]`: used by `[bundle](http://bundler.io/)`
-
-### Repository Setup
-
-Then, to make your local copy of the repository ready to use the [git-flow](https://github.com/nvie/gitflow) workflow and the local [RVM](https://rvm.io/)  setup, you have to run the following commands once you cloned it for the first time: 
-
-      $> gem install bundler    # assuming it is not yet available
-	  $> bundle install
-	  $> rake -T                # To list the available tasks
-      $> rake setup 
-
-You probably wants to activate the bash-completion for rake tasks.
-I personnaly use the one provided [here](https://github.com/ai/rake-completion)
-
-Also, some of the tasks are hidden. Run `rake -T -A` to list all of them. 
-
-### RSpec tests
-
-A set of unitary tests are defined to validate the different function of my library using [Rspec](http://rspec.info/) 
-
-You can run these tests by issuing:
-
-	$> rake rspec  # NOT YET IMPLEMENTED
-	
-By conventions, you will find all the currently implemented tests in the `spec/` directory, in files having the `_spec.rb` suffix. This is expected from the `rspec` task of the `Rakefile`.
-
-**Important** Kindly stick to this convention, and feature tests for all   definitions/classes/modules you might want to add. 
-
-### Releasing mechanism
-
-The operation consisting of releasing a new version of this repository is
-automated by a set of tasks within the `Rakefile`. 
-
-In this context, a version number have the following format:
-
-      <major>.<minor>.<patch>
-
-where:
-
-* `< major >` corresponds to the major version number
-* `< minor >` corresponds to the minor version number
-* `< patch >` corresponds to the patching version number
-
-Example: `1.2.0`
-
-The current version number is stored in the file `metadata.json`. 
-For more information on the version, run:
-
-     $> rake version:info
-
-If a new  version number such be bumped, you simply have to run:
-
-     $> rake version:bump:{major,minor,patch}
-
-This will start the release process for you using `git-flow`.
-Then, to make the release effective, just run:
-
-     $> rake version:release
-
-This will finalize the release using `git-flow`, create the appropriate tag and merge all things the way they should be. 
-
-# Contributing Notes
-
-This project is released under the terms of the [<%= config[:license] %> Licence](LICENSE). 
-So you are more than welcome to contribute to its development as follows: 
-
-1. Fork it
-2. Create your feature branch (`rake git:feature:start[<feature_name>]`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git flow feature publish <feature_name>`)
-5. Create new Pull Request
-