diff options
author | Tim Smith <tsmith84@gmail.com> | 2020-06-15 11:40:13 -0700 |
---|---|---|
committer | Tim Smith <tsmith84@gmail.com> | 2020-06-15 11:40:13 -0700 |
commit | 96d3390e5459d2d31f80657402958aee26730da7 (patch) | |
tree | 964d66cdae61deb4e1059f4db35eca8003ed0b41 /lib | |
parent | c54d5a89c44b4dd36453b4858c9dec6d3189db40 (diff) | |
download | chef-96d3390e5459d2d31f80657402958aee26730da7.tar.gz |
Improve resource documentation
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/chef/resource/windows_audit_policy.rb | 22 | ||||
-rw-r--r-- | lib/chef/resource/windows_auto_run.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/windows_certificate.rb | 2 |
3 files changed, 13 insertions, 13 deletions
diff --git a/lib/chef/resource/windows_audit_policy.rb b/lib/chef/resource/windows_audit_policy.rb index 45f613bc28..684fafcd15 100644 --- a/lib/chef/resource/windows_audit_policy.rb +++ b/lib/chef/resource/windows_audit_policy.rb @@ -92,10 +92,10 @@ class Chef ```ruby windows_audit_policy "Set Audit Policy for 'Logon and Logoff' actions to 'Success and Failure'" do - subcategory %w(Logon Logoff) - success true - failure true - action :set + subcategory %w(Logon Logoff) + success true + failure true + action :set end ``` @@ -103,19 +103,19 @@ class Chef ```ruby windows_audit_policy "Set Audit Policy for 'Credential Validation' actions to 'Success'" do - subcategory "Credential Validation" - success true - failure false - action :set + subcategory 'Credential Validation' + success true + failure false + action :set end ``` **Enable CrashOnAuditFail option**: ```ruby - windows_audit_policy "Enable CrashOnAuditFail option" do - crash_on_audit_fail true - action :set + windows_audit_policy 'Enable CrashOnAuditFail option' do + crash_on_audit_fail true + action :set end ``` DOC diff --git a/lib/chef/resource/windows_auto_run.rb b/lib/chef/resource/windows_auto_run.rb index 11f383b9d3..0b34d6c971 100644 --- a/lib/chef/resource/windows_auto_run.rb +++ b/lib/chef/resource/windows_auto_run.rb @@ -26,7 +26,7 @@ class Chef description "Use the **windows_auto_run** resource to set applications to run at login." introduced "14.0" examples <<~DOC - **Run BGInfo at login**: + **Run BGInfo at login** ```ruby windows_auto_run 'BGINFO' do diff --git a/lib/chef/resource/windows_certificate.rb b/lib/chef/resource/windows_certificate.rb index 967ef2f811..bb3733cd75 100644 --- a/lib/chef/resource/windows_certificate.rb +++ b/lib/chef/resource/windows_certificate.rb @@ -36,7 +36,7 @@ class Chef ```ruby windows_certificate 'c:/test/mycert.pfx' do pfx_password 'password' - private_key_acl ["acme\fred", "pc\jane"] + private_key_acl ["acme\\fred", "pc\\jane"] end ``` |