diff options
author | Tim Smith <tsmith@chef.io> | 2018-08-30 21:09:57 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-08-31 17:17:24 -0700 |
commit | 27b1673b0ff2b88a0888e6444c3b027438242d8b (patch) | |
tree | 230e8d99b3eef0ba7d2f3a1bfa4481e8ca6bc35d | |
parent | e16b9463c221f4e4a10c8eda7ec8ad034254c2fd (diff) | |
download | chef-27b1673b0ff2b88a0888e6444c3b027438242d8b.tar.gz |
More syncs from the docs siteresource_docs_cleanup
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | lib/chef/resource/sudo.rb | 14 | ||||
-rw-r--r-- | lib/chef/resource/swap_file.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/windows_ad_join.rb | 8 | ||||
-rw-r--r-- | lib/chef/resource/windows_auto_run.rb | 6 |
4 files changed, 16 insertions, 16 deletions
diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb index 87799e5bbb..c417a4d26c 100644 --- a/lib/chef/resource/sudo.rb +++ b/lib/chef/resource/sudo.rb @@ -56,15 +56,15 @@ class Chef default: ["ALL"] property :host, String, - description: "The host to set in the sudo config.", + description: "The host to set in the sudo configuration.", default: "ALL" property :runas, String, - description: "User the command(s) can be run as.", + description: "User that the command(s) can be run as.", default: "ALL" property :nopasswd, [TrueClass, FalseClass], - description: "Allow running sudo without specifying a password sudo.", + description: "Allow sudo to be run without specifying a password.", default: false property :noexec, [TrueClass, FalseClass], @@ -83,11 +83,11 @@ class Chef default: lazy { [] } property :command_aliases, Array, - description: "Command aliases that can be used as allowed commands later in the config.", + description: "Command aliases that can be used as allowed commands later in the configuration.", default: lazy { [] } property :setenv, [TrueClass, FalseClass], - description: "Whether to permit the preserving of environment with sudo -E.", + description: "Determines whether or not to permit preservation of the environment with 'sudo -E'.", default: false property :env_keep_add, Array, @@ -102,11 +102,11 @@ class Chef description: "Deprecated property. Do not use." property :visudo_binary, String, - description: "The path to visudo for config verification.", + description: "The path to visudo for configuration verification.", default: "/usr/sbin/visudo" property :config_prefix, String, - description: "The directory containing the sudoers config file.", + description: "The directory that contains the sudoers configuration file", default: lazy { platform_config_prefix } # handle legacy cookbook property diff --git a/lib/chef/resource/swap_file.rb b/lib/chef/resource/swap_file.rb index ea7440a890..c42c7b6d59 100644 --- a/lib/chef/resource/swap_file.rb +++ b/lib/chef/resource/swap_file.rb @@ -31,14 +31,14 @@ class Chef name_property: true property :size, Integer, - description: "The size (in MBs) for the swap file." + description: "The size (in MBs) of the swap file." property :persist, [TrueClass, FalseClass], description: "Persist the swapon.", default: false property :timeout, Integer, - description: "Timeout for dd/fallocate.", + description: "Timeout for 'dd' / 'fallocate' commands.", default: 600 property :swappiness, Integer, diff --git a/lib/chef/resource/windows_ad_join.rb b/lib/chef/resource/windows_ad_join.rb index 4917fa6be1..d2848c71cd 100644 --- a/lib/chef/resource/windows_ad_join.rb +++ b/lib/chef/resource/windows_ad_join.rb @@ -30,21 +30,21 @@ class Chef introduced "14.0" property :domain_name, String, - description: "The FQDN of the AD domain to join.", + description: "The FQDN of the Active Directory domain to join.", validation_message: "The 'domain_name' property must be a FQDN.", regex: /.\../, # anything.anything name_property: true property :domain_user, String, - description: "The domain user to use to join the host to the domain.", + description: "The domain user that will be used to join the domain.", required: true property :domain_password, String, - description: "The password for the domain user.", + description: "The password for the domain user. Note that this resource is set to hide sensitive information by default. ", required: true property :ou_path, String, - description: "The path to the OU where you would like to place the host." + description: "The path to the Organizational Unit where the host will be placed." property :reboot, Symbol, equal_to: [:immediate, :delayed, :never, :request_reboot, :reboot_now], diff --git a/lib/chef/resource/windows_auto_run.rb b/lib/chef/resource/windows_auto_run.rb index af692493b4..0ff8c24bfc 100644 --- a/lib/chef/resource/windows_auto_run.rb +++ b/lib/chef/resource/windows_auto_run.rb @@ -24,7 +24,7 @@ class Chef resource_name :windows_auto_run provides(:windows_auto_run) { true } - description "Use the windows_auto_run resource to set applications to run at logon." + description "Use the windows_auto_run resource to set applications to run at login." introduced "14.0" property :program_name, String, @@ -33,10 +33,10 @@ class Chef property :path, String, coerce: proc { |x| x.tr("/", "\\") }, # make sure we have windows paths for the registry - description: "The path to the program to be run at login." + description: "The path to the program that will run at login. " property :args, String, - description: "Any arguments for the program." + description: "Any arguments to be used with the program." property :root, Symbol, description: "The registry root key to put the entry under.", |