Automatic README conversion from rdoc to md

README_check.rdoc → README_check.md

@@ -1,10 +1,10 @@
-= PUPPI CHECK INSTRUCTIONS
+# PUPPI CHECK INSTRUCTIONS
 Documentation and examples related to the puppi action check
 
-== SYNOPSIS (cli)
+## SYNOPSIS (cli)
         puppi check [project_name] [-r yes|no|fail]
 
-== EXAMPLES (cli)
+## EXAMPLES (cli)
 Run host-wide checks.
         puppi check
 Run project "myapp" specific tests AND host-wide checks
@@ -19,7 +19,7 @@ Run checks and send reports
 Run checks and show only failed ones
         puppi check -s fail
 
-== EXAMPLES (puppet)
+## EXAMPLES (puppet)
 The basic define related to a check is:
         puppi::check   - Creates a single command to be placed in the check sequence.
 
@@ -48,7 +48,7 @@ You can also use custom scripts for your checks. They should behave similarly to
         }
 
 
-== EXAMPLES (with example42 puppet modules)
+## EXAMPLES (with example42 puppet modules)
 If you use the whole Example42 modules set you get automatically many service related checks out of the box.
 Just set (via an ENC, facts or manifests) these puppet variables:
         $monitor="yes" # To enable automagic monitoring

README_deploy.rdoc → README_deploy.md

@@ -1,7 +1,7 @@
-= PUPPI DEPLOY INSTRUCTIONS
+# PUPPI DEPLOY INSTRUCTIONS
 Documentation and examples related to the puppi actions: deploy, rollback and init
 
-== SYNOPSIS (COMMAND LINE)
+## SYNOPSIS (COMMAND LINE)
 Shell command to launch a deploy:
         puppi deploy <project_name>
         puppi deploy <project_name> [-f] [-i] [-t] [-d yes|full] [-r yes|no|fail] [-p "parameter=value parameter2=value2"]
@@ -13,7 +13,7 @@ Shell command to launch the first deploy:
         puppi init <project_name>
 
 
-== EXAMPLES (cli)
+## EXAMPLES (cli)
 
 Deploy myapp with the standard logic/parameters defined in Puppet:
         puppi deploy myapp
@@ -44,7 +44,7 @@ Automatically rollback to the latest saved state (unattended).
         puppi rollback myapp latest
 
 
-== EXAMPLES (puppet)
+## EXAMPLES (puppet)
 Here follow some sample defines you can use out of the box in your manifests once you include puppi.
 Get a war from $source and deploy it in $deploy_root:
         puppi::project::war { 'myapp':
@@ -171,7 +171,7 @@ These are just examples, possibilities are many, refer to the docs in puppi/mani
 to have a full list of the available options.
 
 
-== BASIC PUPPI DEFINES
+## BASIC PUPPI DEFINES
 The above puppi::projects defines manage more or less complex deployments procedures for different kind of projects. They are just samples of possible procedures and you may create your one ones, if the ones provided there don't fit your needs.
 They will have to contain one or more of these basic puppi defines.
 
@@ -204,7 +204,7 @@ Its content is, simply:
         su - ${user} -c "export project=${project} && /etc/puppi/scripts/${command} ${arguments}"
 
 
-== DEPLOY PROCEDURES DEFINES
+## DEPLOY PROCEDURES DEFINES
 The puppi module provides some examples of deploy workflows they are in the puppi/manifests/project
 directory and contain simple to use defines that contain one puppi::project and several puppi::deploy and
 puppi::rollback defines to design a specific workflow using the builtin commands present in
@@ -233,7 +233,7 @@ Full documentation is available in the relevant .pp files
 - puppi::project::builder - This is a general purpose define that incorporates most the of cases provided by the above procedures
 
 
-== BUILTIN COMMANDS
+## BUILTIN COMMANDS
 The puppi/files/scripts directory in the module contains some general usage "native" bash scripts
 that can be used in custom deployments. They are generally made to work together according to a
 specific logic, which is at the base of the deploy procedures defines in puppi/manifests/project/

README_info.rdoc → README_info.md

@@ -1,11 +1,11 @@
-= PUPPI INFO README
+# PUPPI INFO README
 The puppi info commands executes scripts in /etc/puppi/info/ which are generated by templates provided by the puppi::info define
 These scripts are supposed to show status details on the omonimous info topic.
 
-== SYNOPSIS (cli)
+## SYNOPSIS (cli)
         puppi info [topic] [-i]
 
-== EXAMPLES (cli)
+## EXAMPLES (cli)
 Show host-wide infos. Much stuff.
         puppi info
 
@@ -22,7 +22,7 @@ Grep the output with the string defined
         puppi info -g <string>
 
 
-== EXAMPLES (puppet)
+## EXAMPLES (puppet)
 The basic define related to a info is puppi::info, it creates a script executed
 when running "puppi info $name" based on the provided template.
 Customize the template to customize the info you want to see.
@@ -52,7 +52,7 @@ own defines. For example in a define that creates a tomcat instance you can add
 which has custom arguments, feeded by the data you provided to the define, and a custom
 template file that uses these variables. 
 
-== EXAMPLES (with example42 puppet modules)
+## EXAMPLES (with example42 puppet modules)
 If you use the old Example42 modules set you get automatically many service related infos out of the box to be used with Puppi One.
 NextGen modules are supposed to provide pupi info intergration on Puppi Two (TO DO)
 Just set (via an ENC, facts or manifests) $puppi=yes to enable puppi extensions autoloading.

README_log.rdoc → README_log.md

@@ -1,10 +1,10 @@
-= PUPPI LOG README
+# PUPPI LOG README
 Documentation and examples related to the puppi action log
 
-== SYNOPSIS (cli)
+## SYNOPSIS (cli)
         puppi log [topic] [-i]
 
-== EXAMPLES (cli)
+## EXAMPLES (cli)
 
 Tails (tail -10f) all the known logs.
         puppi log
@@ -18,7 +18,7 @@ Choose interactively which logs to show
 Grep the output with the string defined
         puppi log -g <string>
 
-== EXAMPLES (puppet)
+## EXAMPLES (puppet)
 The basic define related to a log is:
         puppi::log
 it creates a file in /etc/puppi/logs/ with one or more logs paths.