summaryrefslogtreecommitdiff
path: root/tasks
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2020-10-28 14:06:38 -0700
committerGitHub <noreply@github.com>2020-10-28 14:06:38 -0700
commit79772c0ca81d6c7481f74aa07ae5a5873698cf24 (patch)
tree71c8b2c33ac660a14ed700038806061be50a9999 /tasks
parent31f8eb6fec0a1d5724c7351a3a4285bfa40c2172 (diff)
parenta10fb12a67d885f96d165f4853453e6d2914086b (diff)
downloadchef-79772c0ca81d6c7481f74aa07ae5a5873698cf24.tar.gz
Merge pull request #10567 from chef/docs_generation_updates
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'tasks')
-rwxr-xr-xtasks/docs.rb15
1 files changed, 8 insertions, 7 deletions
diff --git a/tasks/docs.rb b/tasks/docs.rb
index 4bce62695e..5ad4d2baf4 100755
--- a/tasks/docs.rb
+++ b/tasks/docs.rb
@@ -1,3 +1,5 @@
+RESOURCES_TO_SKIP = ["whyrun_safe_ruby_block", "l_w_r_p_base", "user_resource_abstract_base_class", "linux_user", "pw_user", "aix_user", "dscl_user", "solaris_user", "windows_user", "mac_user", ""].freeze
+
namespace :docs_site do
desc "Generate resource documentation pages in a docs_site directory"
@@ -11,8 +13,6 @@ namespace :docs_site do
require "fileutils"
require "yaml"
- RESOURCES_TO_SKIP = ["whyrun_safe_ruby_block", "l_w_r_p_base", "user_resource_abstract_base_class", "linux_user", "pw_user", "aix_user", "dscl_user", "solaris_user", "windows_user", "mac_user", ""].freeze
-
# @return [String, nil] a pretty default value string or nil if we want to skip it
def pretty_default(default)
return nil if default.nil? || default == "" || default == "lazy default"
@@ -168,11 +168,14 @@ namespace :docs_site do
end
end
- def special_properties(name, data)
+ def special_properties(name)
properties = {}
# these package properties support passing arrays for the package name
- properties["common_resource_functionality_multiple_packages"] = true if %w{yum_package apt_package zypper_package homebrew_package dnf_package pacman_package homebrew_package}.include?(name)
+ if %w{snap_package dpkg_package yum_package apt_package zypper_package homebrew_package dnf_package pacman_package homebrew_package}.include?(name)
+ properties["common_resource_functionality_multiple_packages"] = true
+ properties["properties_multiple_packages"] = true
+ end
properties["common_resource_functionality_resources_common_windows_security"] = true if name == "remote_directory"
@@ -188,8 +191,6 @@ namespace :docs_site do
properties["nameless_build_essential"] = true if name == "build_essential"
- properties["properties_multiple_packages"] = true if %w{dnf_package package zypper_package}.include?(name)
-
properties["properties_resources_common_windows_security"] = true if %w{cookbook_file file template remote_file directory}.include?(name)
properties["properties_shortcode"] = "resource_log_properties.md" if name == "log"
@@ -274,7 +275,7 @@ namespace :docs_site do
r["resource_reference"] = true
# These properties are set to special values for only a few resources.
- r.merge!(special_properties(name, data))
+ r.merge!(special_properties(name))
r["title"] = "#{name} resource"
r["resource"] = name