diff options
| author | William Theaker <williamtheaker@users.noreply.github.com> | 2022-06-14 15:44:34 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-14 12:44:34 -0700 |
| commit | 09635c40aa7144c91c9b1090eb2c2c48b87ae670 (patch) | |
| tree | 7fbaa813a528b02ca354e00e592bde5c533b0d93 | |
| parent | 86320e00745c9f0203bef71f12cc807a92323938 (diff) | |
| download | chef-09635c40aa7144c91c9b1090eb2c2c48b87ae670.tar.gz | |
Fix documentation for chef_client_scheduled_task (#12917)
* Fix documentation for chef_client_scheduled_task
* Use full knife doc URI; Incorporate suggestion.
Signed-off-by: William Theaker <william.theaker@gusto.com>
| -rw-r--r-- | knife/lib/chef/knife/core/ui.rb | 2 | ||||
| -rw-r--r-- | knife/lib/chef/knife/edit.rb | 2 | ||||
| -rw-r--r-- | knife/lib/chef/knife/user_edit.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/chef_client_scheduled_task.rb | 3 |
4 files changed, 5 insertions, 4 deletions
diff --git a/knife/lib/chef/knife/core/ui.rb b/knife/lib/chef/knife/core/ui.rb index 782df1ca10..9eda4615f5 100644 --- a/knife/lib/chef/knife/core/ui.rb +++ b/knife/lib/chef/knife/core/ui.rb @@ -233,7 +233,7 @@ class Chef tf.sync = true tf.puts output tf.close - raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." unless system("#{config[:editor]} #{tf.path}") + raise "Please set EDITOR environment variable. See https://docs.chef.io/workstation/knife_setup/#setting-your-text-editor for details." unless system("#{config[:editor]} #{tf.path}") output = IO.read(tf.path) end diff --git a/knife/lib/chef/knife/edit.rb b/knife/lib/chef/knife/edit.rb index 45702d168b..87e19b1583 100644 --- a/knife/lib/chef/knife/edit.rb +++ b/knife/lib/chef/knife/edit.rb @@ -74,7 +74,7 @@ class Chef # Let the user edit the temporary file unless system("#{config[:editor]} #{file.path}") - raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." + raise "Please set EDITOR environment variable. See https://docs.chef.io/workstation/knife_setup/#setting-your-text-editor for details." end result_text = IO.read(file.path) diff --git a/knife/lib/chef/knife/user_edit.rb b/knife/lib/chef/knife/user_edit.rb index fff8c6b70f..8b937189df 100644 --- a/knife/lib/chef/knife/user_edit.rb +++ b/knife/lib/chef/knife/user_edit.rb @@ -81,7 +81,7 @@ class Chef f.sync = true f.puts output f.close - raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." unless system("#{config[:editor]} #{f.path}") + raise "Please set EDITOR environment variable. See https://docs.chef.io/workstation/knife_setup/#setting-your-text-editor for details." unless system("#{config[:editor]} #{f.path}") edited_user = JSON.parse(IO.read(f.path)) end diff --git a/lib/chef/resource/chef_client_scheduled_task.rb b/lib/chef/resource/chef_client_scheduled_task.rb index a7e0d0761c..422881deb8 100644 --- a/lib/chef/resource/chef_client_scheduled_task.rb +++ b/lib/chef/resource/chef_client_scheduled_task.rb @@ -122,7 +122,8 @@ class Chef property :config_directory, String, description: "The path of the config directory.", - default: ChefConfig::Config.etc_chef_dir + default: ChefConfig::Config.etc_chef_dir, + default_description: ChefConfig::Config.c_chef_dir property :log_directory, String, description: "The path of the directory to create the log file in.", |