From 034f00f6c466c3924e5fdb069b484d1961283c76 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 19 Dec 2017 11:22:19 -0800 Subject: Add descriptions and @since comments to all resources From the docs site Signed-off-by: Tim Smith --- lib/chef/resource/template.rb | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'lib/chef/resource/template.rb') 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 -- cgit v1.2.1