summaryrefslogtreecommitdiff
path: root/templates/README.markdown
diff options
context:
space:
mode:
authorRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
committerRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
commitab3edf97f92853fe40b92670d5d4ec9adfbeddcc (patch)
tree82245f8fb56e2611bc0c1dde5868418b625e34cf /templates/README.markdown
parent5015ec6190ea415f080e6c062e57fc9bb0be96e1 (diff)
Update Documentation and Purge Extras
Commit message from laurenrother Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub as well as the Forge Module Description. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards. Extraneous, empty READMEs were deleted.
Diffstat (limited to 'templates/README.markdown')
-rw-r--r--templates/README.markdown23
1 files changed, 0 insertions, 23 deletions
diff --git a/templates/README.markdown b/templates/README.markdown
deleted file mode 100644
index 575bbea..0000000
--- a/templates/README.markdown
+++ /dev/null
@@ -1,23 +0,0 @@
-Templates
-=========
-
-Puppet supports templates and templating via ERB, which is part of the Ruby
-standard library and is used for many other projects including Ruby on Rails.
-Templates allow you to manage the content of template files, for example
-configuration files that cannot yet be managed as a Puppet type. Learn more at
-http://projects.puppetlabs.com/projects/puppet/wiki/Puppet_Templating
-
-You can use templates like this:
-
- class myclass {
- package { mypackage: ensure => latest }
- service { myservice: ensure => running }
- file { "/etc/myfile":
- content => template("mymodule/myfile.erb")
- }
- }
-
-The templates are searched for in:
-
- $templatedir/mymodule/myfile.erb
- $modulepath/mymodule/templates/myfile.erb