Resource docs update from docs review

These came out of https://github.com/chef/chef-web-docs/pull/3592

Signed-off-by: Tim Smith <tsmith@chef.io>

3 files changed, 13 insertions, 14 deletions

diff --git a/lib/chef/resource/chef_client_config.rb b/lib/chef/resource/chef_client_config.rb
index ed5f3b26a8..df97d7cc2f 100644
--- a/lib/chef/resource/chef_client_config.rb
+++ b/lib/chef/resource/chef_client_config.rb
@@ -97,7 +97,6 @@ class Chef
         data_collector_token 'TEST_TOKEN_TEST'
       end
       ```
-
       DOC
 
       # @todo policy_file or policy_group being set requires the other to be set so enforce that.
@@ -243,11 +242,11 @@ class Chef
         description: "Additional text to add at the bottom of the client.rb config. This can be used to run custom Ruby or to add less common config options"
 
       property :data_collector_server_url, String,
-        description: "The data collector url (typically automate) to send node, converge and compliance data. Note: Data collection reporting to Automate should be performed directly by Chef Infra Server if possible, as this removes the need to distribute tokens to individual nodes.",
+        description: "The data collector URL (typically automate) to send node, converge, and compliance data. Note: If possible, use Chef Infra Server to do all data collection reporting, as this removes the need to distribute tokens to individual nodes.",
         introduced: "17.8"
 
       property :data_collector_token, String,
-        description: "The data collector token to interact with the data collector server url (Automate). Note: Data collection reporting to Automate should be performed directly by Chef Infra Server if possible, as this removes the need to distribute tokens to individual nodes.",
+        description: "The data collector token to interact with the data collector server URL (Automate). Note: If possible, use Chef Infra Server to do all data collection reporting, as this removes the need to distribute tokens to individual nodes.",
         introduced: "17.8"
 
       action :create, description: "Create a client.rb config file for configuring #{ChefUtils::Dist::Infra::PRODUCT}." do
diff --git a/lib/chef/resource/powershell_package_source.rb b/lib/chef/resource/powershell_package_source.rb
index 48962f7007..bfb578d13d 100644
--- a/lib/chef/resource/powershell_package_source.rb
+++ b/lib/chef/resource/powershell_package_source.rb
@@ -25,10 +25,10 @@ class Chef
 
       provides :powershell_package_source
 
-      description "Use the **powershell_package_source** resource to register a PowerShell package source and a Powershell package provider. There are 2 distinct objects we care about here. The first is a Package Source like a PowerShell Repository or a Nuget Source. The second object is a provider that PowerShell uses to get to that source with, like PowerShellGet, Nuget, Chocolatey, etc. "
+      description "Use the **powershell_package_source** resource to register a PowerShell package source and a Powershell package provider. There are two distinct objects we care about here. The first is a package source like a PowerShell repository or a NuGet Source. The second object is a provider that PowerShell uses to get to that source with, like PowerShellGet, NuGet, Chocolatey, etc."
       introduced "14.3"
       examples <<~DOC
-        **Add a new PSRepository that is not trusted and which requires credentials to connect to**:
+        **Add a new PowerShell repository that is not trusted and which requires credentials to connect to**:
 
         ```ruby
         powershell_package_source 'PowerShellModules' do
@@ -43,7 +43,7 @@ class Chef
         end
         ```
 
-        **Add a new Package Source that uses Chocolatey as the Package Provider**:
+        **Add a new package source that uses Chocolatey as the package provider**:
 
         ```ruby
         powershell_package_source 'PowerShellModules' do
@@ -56,7 +56,7 @@ class Chef
         end
         ```
 
-        **Add a new PowerShell Script source that is trusted**:
+        **Add a new PowerShell script source that is trusted**:
 
         ```ruby
         powershell_package_source 'MyDodgyScript' do
@@ -68,7 +68,7 @@ class Chef
         end
         ```
 
-        **Update my existing PSRepository to make it Trusted after all**:
+        **Update an existing PowerShell repository to make it trusted**:
 
         ```ruby
         powershell_package_source 'MyPSModule' do
@@ -137,7 +137,7 @@ class Chef
         description: "The location where scripts will be published to for this source. Only valid if the provider is `PowerShellGet`."
 
       property :trusted, [TrueClass, FalseClass],
-        description: "Whether or not to trust packages from this source. Used when creating a NON-PSRepository Package Source",
+        description: "Whether or not to trust packages from this source. Used when creating a non-PowerShell repository package source.",
         default: false
 
       property :user, String,
@@ -151,7 +151,7 @@ class Chef
       property :provider_name, String,
         equal_to: %w{ Programs msi NuGet msu PowerShellGet psl chocolatey winget },
         validation_message: "The following providers are supported: 'Programs', 'msi', 'NuGet', 'msu', 'PowerShellGet', 'psl', 'chocolatey' or 'winget'",
-        description: "The package management provider for the package source. The default is PowerShellGet and this option need only be set otherwise in specific use cases.",
+        description: "The package management provider for the package source. The default is `PowerShellGet`. Only change this option in specific use cases.",
         default: "NuGet"
 
       load_current_value do
@@ -202,7 +202,7 @@ class Chef
         end
       end
 
-      action :set, description: "Updates an existing PSRepository or Package Source" do
+      action :set, description: "Updates an existing PSRepository or Package Source." do
         package_details = get_package_source_details
         output = package_details.result
         if output == "PSRepository"
diff --git a/lib/chef/resource/rhsm_register.rb b/lib/chef/resource/rhsm_register.rb
index 2f4b5fa6f5..8a7d748920 100644
--- a/lib/chef/resource/rhsm_register.rb
+++ b/lib/chef/resource/rhsm_register.rb
@@ -80,7 +80,7 @@ class Chef
         introduced: "15.9"
 
       property :server_url, String,
-        description: "The hostname of the subscription service to use. The default is for Customer Portal Subscription Management, subscription.rhn.redhat.com. If this option is not used, the system is registered with Customer Portal Subscription Management.",
+        description: "The hostname of the subscription service to use. The default is Customer Portal Subscription Management, subscription.rhn.redhat.com. If you do not use this option, the system registers with Customer Portal Subscription Management.",
           introduced: "17.8"
 
       property :base_url, String,
@@ -88,12 +88,12 @@ class Chef
         introduced: "17.8"
 
       property :service_level, String,
-        description: "Sets the service level to use for subscriptions on the registering machine. This is only used with the auto_attach option.",
+        description: "Sets the service level to use for subscriptions on the registering machine. This is only used with the `auto_attach` option.",
         introduced: "17.8"
 
       property :release,
         [Float, String],
-        description: "Sets the operating system minor release to use for subscriptions for the system. Products and updates are limited to the specified minor release version. This is used only used with the auto_attach option.  For example, `release '6.4'` will append `--release=6.4` to the register command.",
+        description: "Sets the operating system minor release to use for subscriptions for the system. Products and updates are limited to the specified minor release version. This is used only used with the `auto_attach` option.  For example, `release '6.4'` will append `--release=6.4` to the register command.",
         introduced: "17.8"
 
       action :register, description: "Register the node with RHSM." do