From 77dbe985cd1f3b2aa9230d63c45d92096b554da1 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Tue, 28 Nov 2023 12:56:14 -0500 Subject: [PATCH] Correct cookbook files resource (#4212) * Correct cookbook files resource Signed-off-by: Ian Maddaus * Lint Signed-off-by: Ian Maddaus --------- Signed-off-by: Ian Maddaus --- data/infra/resources/cookbook_file.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/data/infra/resources/cookbook_file.yaml b/data/infra/resources/cookbook_file.yaml index 6279225b30..1a7b43ab37 100644 --- a/data/infra/resources/cookbook_file.yaml +++ b/data/infra/resources/cookbook_file.yaml @@ -10,7 +10,12 @@ resource: cookbook_file resource_description_list: - shortcode: resource_cookbook_file_summary.md - markdown: |- - During a Chef Infra Client run, the checksum for each local file is calculated and then compared against the checksum for the same file as it currently exists in the cookbook on the Chef Infra Server. A file is not transferred when the checksums match. Only files that require an update are transferred from the Chef Infra Server to a node. + During a Chef Infra Client run, the checksum for each local file is calculated and then compared against the checksum for the same file as it currently exists in the cookbook on the Chef Infra Server. A file isn't transferred when the checksums match. Only files that require an update are transferred from the Chef Infra Server to a node. +syntax_description: "A **cookbook_file** resource block manages files by using files\ + \ that\nexist within a cookbook's `/files` directory. For example, to write the\n\ + home page for an Apache website:\n\n```ruby\ncookbook_file '/var/www/customers/public_html/index.php'\ + \ do\n source 'index.php'\n owner 'web_admin'\n group 'web_admin'\n mode '0755'\n\ + \ action :create\nend\n```" syntax_full_code_block: |- cookbook_file 'name' do atomic_update true, false