diff options
author | Tim Smith <tsmith84@gmail.com> | 2021-02-04 14:31:09 -0800 |
---|---|---|
committer | Tim Smith <tsmith84@gmail.com> | 2021-02-04 14:31:09 -0800 |
commit | 595e16467219d4caefe26fd976c3d046162ad700 (patch) | |
tree | 2e23adaf6c85d225c0b5cd402efa81bd646c634c /tasks | |
parent | b738b731fd5a2264e1ee5c03f9c27e9de6d0f0e7 (diff) | |
download | chef-595e16467219d4caefe26fd976c3d046162ad700.tar.gz |
Improve auto-generated documentation
Skip sensitive properties in the docs pages since there are already in the common docs pages
Start using action descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'tasks')
-rwxr-xr-x | tasks/docs.rb | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/tasks/docs.rb b/tasks/docs.rb index 5d336a7b14..0a31ead498 100755 --- a/tasks/docs.rb +++ b/tasks/docs.rb @@ -35,6 +35,8 @@ namespace :docs_site do text = "" text << "#{resource_name} 'name' do\n" properties.each do |p| + next if p["name"] == "sensitive" # we don't need to document sensitive twice + pretty_default = pretty_default(p["default"]) text << " #{p["name"].ljust(padding_size)}" @@ -139,7 +141,9 @@ namespace :docs_site do # TODO: # - what to do about "lazy default" for default? def properties_list(properties) - properties.map do |property| + properties.filter_map do |property| + next if property["name"] == "sensitive" # we don't need to document sensitive twice + default_val = friendly_default_value(property) values = {} |