summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2021-10-11 09:17:23 -0700
committerGitHub <noreply@github.com>2021-10-11 09:17:23 -0700
commit75ec4fc1e791969b18224cd7d1e3e00e79fdd017 (patch)
treea702722146a09b9654e60719b4bd9533cce13767
parentb3f58a305536014825247dd74a4c68d2b45b43c7 (diff)
parent32f0f245f5f451ebab60e6549ab7c3a35021caa3 (diff)
downloadchef-75ec4fc1e791969b18224cd7d1e3e00e79fdd017.tar.gz
Merge pull request #12157 from gep13/choco_docs
(doc) Add note about requirement for Chocolatey
-rw-r--r--lib/chef/resource/chocolatey_config.rb2
-rw-r--r--lib/chef/resource/chocolatey_feature.rb2
-rw-r--r--lib/chef/resource/chocolatey_source.rb2
3 files changed, 3 insertions, 3 deletions
diff --git a/lib/chef/resource/chocolatey_config.rb b/lib/chef/resource/chocolatey_config.rb
index 6114dbe18c..61a14d70b7 100644
--- a/lib/chef/resource/chocolatey_config.rb
+++ b/lib/chef/resource/chocolatey_config.rb
@@ -21,7 +21,7 @@ class Chef
provides :chocolatey_config
- description "Use the **chocolatey_config** resource to add or remove Chocolatey configuration keys."
+ description "Use the **chocolatey_config** resource to add or remove Chocolatey configuration keys. Note: The Chocolatey package manager is not installed on Windows by default. You will need to install it prior to using this resource by adding the [Chocolatey cookbook](https://supermarket.chef.io/cookbooks/chocolatey/) to your node's run list."
introduced "14.3"
examples <<~DOC
**Set the Chocolatey cacheLocation config**:
diff --git a/lib/chef/resource/chocolatey_feature.rb b/lib/chef/resource/chocolatey_feature.rb
index b56d11376e..67c46bc783 100644
--- a/lib/chef/resource/chocolatey_feature.rb
+++ b/lib/chef/resource/chocolatey_feature.rb
@@ -20,7 +20,7 @@ class Chef
unified_mode true
provides :chocolatey_feature
- description "Use the **chocolatey_feature** resource to enable and disable Chocolatey features."
+ description "Use the **chocolatey_feature** resource to enable and disable Chocolatey features. Note: The Chocolatey package manager is not installed on Windows by default. You will need to install it prior to using this resource by adding the [Chocolatey cookbook](https://supermarket.chef.io/cookbooks/chocolatey/) to your node's run list."
introduced "15.1"
examples <<~DOC
**Enable the checksumFiles Chocolatey feature**
diff --git a/lib/chef/resource/chocolatey_source.rb b/lib/chef/resource/chocolatey_source.rb
index 1b287fc188..e3b35074e3 100644
--- a/lib/chef/resource/chocolatey_source.rb
+++ b/lib/chef/resource/chocolatey_source.rb
@@ -20,7 +20,7 @@ class Chef
unified_mode true
provides :chocolatey_source
- description "Use the **chocolatey_source** resource to add, remove, enable, or disable Chocolatey sources."
+ description "Use the **chocolatey_source** resource to add, remove, enable, or disable Chocolatey sources. Note: The Chocolatey package manager is not installed on Windows by default. You will need to install it prior to using this resource by adding the [Chocolatey cookbook](https://supermarket.chef.io/cookbooks/chocolatey/) to your node's run list."
introduced "14.3"
examples <<~DOC
**Add a Chocolatey source**