From 881d6ba748f426fcc5dd7ecbe7d7380006ed0c70 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Wed, 16 Sep 2020 19:00:09 -0700 Subject: Docs fixes from review Mostly capitalizing things Signed-off-by: Tim Smith --- RELEASE_NOTES.md | 6 +++--- lib/chef/resource/chef_handler.rb | 6 +++--- lib/chef/resource/openssl_ec_public_key.rb | 4 ++-- lib/chef/resource/openssl_x509_request.rb | 6 +++--- lib/chef/resource/powershell_package_source.rb | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index d128f1ad90..e15593346f 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -3011,11 +3011,11 @@ Use the `powershell_package_source` resource to register a PowerShell package re #### Properties - `source_name` - The name of the package source. -- `url` - The url to the package source. +- `url` - The URL to the package source. - `trusted` - Whether or not to trust packages from this source. - `provider_name` - The package management provider for the source. It supports the following providers: 'Programs', 'msi', 'NuGet', 'msu', 'PowerShellGet', 'psl' and 'chocolatey'. -- `publish_location` - The url where modules will be published to for this source. Only valid if the provider is 'PowerShellGet'. -- `script_source_location` - The url where scripts are located for this source. Only valid if the provider is 'PowerShellGet'. +- `publish_location` - The URL where modules will be published to for this source. Only valid if the provider is 'PowerShellGet'. +- `script_source_location` - The URL where scripts are located for this source. Only valid if the provider is 'PowerShellGet'. - `script_publish_location` - The location where scripts will be published to for this source. Only valid if the provider is 'PowerShellGet'. ### kernel_module diff --git a/lib/chef/resource/chef_handler.rb b/lib/chef/resource/chef_handler.rb index 7251050394..b97939d5e5 100644 --- a/lib/chef/resource/chef_handler.rb +++ b/lib/chef/resource/chef_handler.rb @@ -64,7 +64,7 @@ class Chef **Cookbook Versions (a custom handler)** - [@juliandunn](https://github.com/juliandunn) created a custom report handler that logs all of the cookbooks and cookbook versions that were used during a Chef Infra Client run, and then reports after the run is complete. This handler requires the chef_handler resource (which is available from the chef_handler cookbook). + [@juliandunn](https://github.com/juliandunn) created a custom report handler that logs all of the cookbooks and cookbook versions that were used during a Chef Infra Client run, and then reports after the run is complete. cookbook_versions.rb: @@ -110,7 +110,7 @@ class Chef **JsonFile Handler** - The json_file handler is available from the `chef_handler` cookbook and can be used with exceptions and reports. It serializes run status data to a JSON file. This handler may be enabled in one of the following ways. + The JsonFile handler is available from the `chef_handler` cookbook and can be used with exceptions and reports. It serializes run status data to a JSON file. This handler may be enabled in one of the following ways. By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run: @@ -152,7 +152,7 @@ class Chef **ErrorReport Handler** - The error_report handler is built into Chef Infra Client and can be used for both exceptions and reports. It serializes error report data to a JSON file. This handler may be enabled in one of the following ways. + The ErrorReport handler is built into Chef Infra Client and can be used for both exceptions and reports. It serializes error report data to a JSON file. This handler may be enabled in one of the following ways. By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run: diff --git a/lib/chef/resource/openssl_ec_public_key.rb b/lib/chef/resource/openssl_ec_public_key.rb index ec61bc95c2..44441eb72d 100644 --- a/lib/chef/resource/openssl_ec_public_key.rb +++ b/lib/chef/resource/openssl_ec_public_key.rb @@ -31,7 +31,7 @@ class Chef description "Use the **openssl_ec_public_key** resource to generate elliptic curve (EC) public key files from a given EC private key." introduced "14.4" examples <<~DOC - Generate new ec public key from a private key on disk + **Generate new EC public key from a private key on disk** ```ruby openssl_ec_public_key '/etc/ssl_files/eckey_prime256v1_des3.pub' do @@ -41,7 +41,7 @@ class Chef end ``` - Generate new ec public key by passing in a private key + **Generate new EC public key by passing in a private key** ```ruby openssl_ec_public_key '/etc/ssl_files/eckey_prime256v1_des3_2.pub' do diff --git a/lib/chef/resource/openssl_x509_request.rb b/lib/chef/resource/openssl_x509_request.rb index 760c1c970d..0e68337b05 100644 --- a/lib/chef/resource/openssl_x509_request.rb +++ b/lib/chef/resource/openssl_x509_request.rb @@ -31,7 +31,7 @@ class Chef description "Use the **openssl_x509_request** resource to generate PEM-formatted x509 certificates requests. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate." introduced "14.4" examples <<~DOC - **Generate new ec key and csr file** + **Generate new EC key and CSR file** ```ruby openssl_x509_request '/etc/ssl_files/my_ec_request.csr' do @@ -42,7 +42,7 @@ class Chef end ``` - **Generate a new csr file from an existing ec key** + **Generate a new CSR file from an existing EC key** ```ruby openssl_x509_request '/etc/ssl_files/my_ec_request2.csr' do @@ -54,7 +54,7 @@ class Chef end ``` - **Generate new rsa key and csr file** + **Generate new RSA key and CSR file** ```ruby openssl_x509_request '/etc/ssl_files/my_rsa_request.csr' do diff --git a/lib/chef/resource/powershell_package_source.rb b/lib/chef/resource/powershell_package_source.rb index a10140f79e..e17c23abe2 100644 --- a/lib/chef/resource/powershell_package_source.rb +++ b/lib/chef/resource/powershell_package_source.rb @@ -33,7 +33,7 @@ class Chef name_property: true property :url, String, - description: "The url to the package source.", + description: "The URL to the package source.", required: [:register] property :trusted, [TrueClass, FalseClass], @@ -47,10 +47,10 @@ class Chef default: "NuGet" property :publish_location, String, - description: "The url where modules will be published to for this source. Only valid if the provider is `PowerShellGet`." + description: "The URL where modules will be published to for this source. Only valid if the provider is `PowerShellGet`." property :script_source_location, String, - description: "The url where scripts are located for this source. Only valid if the provider is `PowerShellGet`." + description: "The URL where scripts are located for this source. Only valid if the provider is `PowerShellGet`." property :script_publish_location, String, description: "The location where scripts will be published to for this source. Only valid if the provider is `PowerShellGet`." -- cgit v1.2.1