diff options
author | Tim Smith <tsmith@chef.io> | 2021-07-08 17:32:58 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2021-07-08 17:32:58 -0700 |
commit | 12ed0f79b08a82d98b0cdaf9420dbc7e80f5a29f (patch) | |
tree | cdf9f57c956e2ae54d99c0707c2deeba5cbf861e | |
parent | 8e1275bdf14fe0cc96eb2e38565451d43d647edc (diff) | |
download | chef-12ed0f79b08a82d98b0cdaf9420dbc7e80f5a29f.tar.gz |
Minor updates to fix docs generation
Update versions and get ready to generate 17.3 docs
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | lib/chef/resource/chef_client_trusted_certificate.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/gem_package.rb | 3 | ||||
-rw-r--r-- | lib/chef/resource/habitat/habitat_package.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/habitat/habitat_sup.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/habitat_config.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/habitat_install.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/habitat_service.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/habitat_user_toml.rb | 2 |
8 files changed, 10 insertions, 9 deletions
diff --git a/lib/chef/resource/chef_client_trusted_certificate.rb b/lib/chef/resource/chef_client_trusted_certificate.rb index b5272fbe01..7c9562010d 100644 --- a/lib/chef/resource/chef_client_trusted_certificate.rb +++ b/lib/chef/resource/chef_client_trusted_certificate.rb @@ -64,7 +64,7 @@ class Chef property :certificate, String, required: [:add], description: "The text of the certificate file including the BEGIN/END comment lines." - action :add do + action :add, description: "Add a trusted certificate to #{ChefUtils::Dist::Infra::PRODUCT}'s trusted certificate directory" do unless ::Dir.exist?(Chef::Config[:trusted_certs_dir]) directory Chef::Config[:trusted_certs_dir] do mode "0640" @@ -78,7 +78,7 @@ class Chef end end - action :remove do + action :remove, description: "Remove a trusted certificate from #{ChefUtils::Dist::Infra::PRODUCT}'s trusted certificate directory" do file cert_path do action :delete end diff --git a/lib/chef/resource/gem_package.rb b/lib/chef/resource/gem_package.rb index a3ad5f614b..42065d7d86 100644 --- a/lib/chef/resource/gem_package.rb +++ b/lib/chef/resource/gem_package.rb @@ -83,7 +83,8 @@ class Chef property :clear_sources, [ TrueClass, FalseClass, nil ], description: "Set to `true` to download a gem from the path specified by the `source` property (and not from RubyGems).", - default: lazy { Chef::Config[:clear_gem_sources] }, desired_state: false + default: lazy { Chef::Config[:clear_gem_sources] }, + default_description: "false unless `clear_gem_sources` set to true in the `client.rb` config.", desired_state: false property :gem_binary, String, desired_state: false, description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by #{ChefUtils::Dist::Infra::PRODUCT} will be used." diff --git a/lib/chef/resource/habitat/habitat_package.rb b/lib/chef/resource/habitat/habitat_package.rb index 82e64fd189..c4827aba40 100644 --- a/lib/chef/resource/habitat/habitat_package.rb +++ b/lib/chef/resource/habitat/habitat_package.rb @@ -26,7 +26,7 @@ class Chef provides :habitat_package use "habitat_shared" description "Install the specified Habitat package from Habitat Builder." - introduced "17.2" + introduced "17.3" examples <<~DOC ```ruby diff --git a/lib/chef/resource/habitat/habitat_sup.rb b/lib/chef/resource/habitat/habitat_sup.rb index 84ec5cd030..331d821a73 100644 --- a/lib/chef/resource/habitat/habitat_sup.rb +++ b/lib/chef/resource/habitat/habitat_sup.rb @@ -27,7 +27,7 @@ class Chef end description "Runs a Habitat Supervisor for one or more Habitat Services. It is used in conjunction with `habitat_service` which will manage the services loaded and started within the supervisor." - introduced "17.2" + introduced "17.3" property :bldr_url, String, description: "The Habitat Builder URL for the `habitat_package` resource, if needed." diff --git a/lib/chef/resource/habitat_config.rb b/lib/chef/resource/habitat_config.rb index 1be9d12055..5a7333b078 100644 --- a/lib/chef/resource/habitat_config.rb +++ b/lib/chef/resource/habitat_config.rb @@ -43,7 +43,7 @@ class Chef description: "Name of user key to use for encryption. Passes `--user` to `hab config apply`." description "Applies a given configuration to a habitat service using `hab config apply`." - introduced "17.2" + introduced "17.3" examples <<~DOC ```ruby **Configure your nginx defaults** diff --git a/lib/chef/resource/habitat_install.rb b/lib/chef/resource/habitat_install.rb index 0ebdccb0b9..6980594636 100644 --- a/lib/chef/resource/habitat_install.rb +++ b/lib/chef/resource/habitat_install.rb @@ -23,7 +23,7 @@ class Chef provides :habitat_install description "This resource will install the newest stable version of habitat." - introduced "17.2" + introduced "17.3" property :name, String, default: "install habitat", description: "name for your resource block." diff --git a/lib/chef/resource/habitat_service.rb b/lib/chef/resource/habitat_service.rb index 0ef629ec31..21e4fec4eb 100644 --- a/lib/chef/resource/habitat_service.rb +++ b/lib/chef/resource/habitat_service.rb @@ -78,7 +78,7 @@ class Chef Note: Applications may run as a specific user. Often with Habitat, the default is `hab`, or `root`. If the application requires another user, then it should be created with Chef's `user` resource. " - introduced "17.2" + introduced "17.3" examples <<~DOC ```ruby diff --git a/lib/chef/resource/habitat_user_toml.rb b/lib/chef/resource/habitat_user_toml.rb index 6f4339482b..a1bb70f4d0 100644 --- a/lib/chef/resource/habitat_user_toml.rb +++ b/lib/chef/resource/habitat_user_toml.rb @@ -28,7 +28,7 @@ class Chef description: "The service group to apply the configuration to, for example, `nginx.default`." description "Templates a user.toml for the specified service. This is written to `/hab/user/<service_name>/config/user.toml`. User.toml can be used to set configuration overriding the default.toml for a given package as an alternative to applying service group level configuration." - introduced "17.2" + introduced "17.3" examples <<~DOC ```ruby **Configure user specific settings to nginx** |