summaryrefslogtreecommitdiff
path: root/lib/chef/resource/template.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
committerTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
commit034f00f6c466c3924e5fdb069b484d1961283c76 (patch)
treee2f6d9b911c838df661d1bd9cd643858a19847b9 /lib/chef/resource/template.rb
parentfc813e21f253d5278cb42710874a34cfebfcc8ca (diff)
downloadchef-034f00f6c466c3924e5fdb069b484d1961283c76.tar.gz
Add descriptions and @since comments to all resources
From the docs site Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/template.rb')
-rw-r--r--lib/chef/resource/template.rb9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/chef/resource/template.rb b/lib/chef/resource/template.rb
index 896aa71340..4b5b82effb 100644
--- a/lib/chef/resource/template.rb
+++ b/lib/chef/resource/template.rb
@@ -24,6 +24,15 @@ require "chef/mixin/securable"
class Chef
class Resource
+ # A cookbook template is an Embedded Ruby (ERB) template that is used to dynamically generate static text files.
+ # Templates may contain Ruby expressions and statements, and are a great way to manage configuration files. Use the
+ # template resource to add cookbook templates to recipes; place the corresponding Embedded Ruby (ERB) template file
+ # in a cookbook’s /templates directory.
+ #
+ # Use the template resource to manage the contents of a file using an Embedded Ruby (ERB) template by transferring
+ # files from a sub-directory of COOKBOOK_NAME/templates/ to a specified path located on a host that is running the
+ # chef-client. This resource includes actions and properties from the file resource. Template files managed by the
+ # template resource follow the same file specificity rules as the remote_file and file resources.
class Template < Chef::Resource::File
include Chef::Mixin::Securable