Start the conversinon of moving to YAML generation for docsauto_generate

The .rst files are no more on the site. We now parse a yml file in hugo.

Signed-off-by: Tim Smith <tsmith@chef.io>

1 files changed, 54 insertions, 242 deletions

diff --git a/tasks/docs.rb b/tasks/docs.rb
index c347445c2e..bc5a708159 100755
--- a/tasks/docs.rb
+++ b/tasks/docs.rb
@@ -1,6 +1,6 @@
 namespace :docs_site do
 
-  desc "Generate resource documentation .rst pages in a docs_site directory"
+  desc "Generate resource documentation pages in a docs_site directory"
 
   task :resources do
     Encoding.default_external = Encoding::UTF_8
@@ -8,16 +8,8 @@ namespace :docs_site do
     $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
 
     require "chef/resource_inspector"
-    require "erb"
     require "fileutils"
-
-    # @param version String
-    # @return String Chef Infra Client or Chef Client depending on version
-    def branded_chef_client_name(version)
-      return "Chef Infra Client" if Gem::Version.new(version) >= Gem::Version.new("15")
-
-      "Chef Client"
-    end
+    require "yaml"
 
     # @return [String, nil] a pretty defaul value string or nil if we want to skip it
     def pretty_default(default)
@@ -34,20 +26,22 @@ namespace :docs_site do
     # generate the top example resource block example text
     # @param properties Array<Hash>
     # @return String
-    def generate_resource_block(resource_name, properties)
+    def generate_resource_block(resource_name, properties, default_action)
       padding_size = largest_property_name(properties) + 6
 
       # build the resource string with property spacing between property names and comments
-      text = "  #{resource_name} 'name' do\n"
+      text = "The #{resource_name} resource has the following syntax:\n\n"
+      text << "```ruby\n"
+      text << "#{resource_name} 'name' do\n"
       properties.each do |p|
-        text << "    #{p["name"].ljust(padding_size)}"
+        text << "  #{p["name"].ljust(padding_size)}"
         text << friendly_types_list(p["is"])
         text << " # default value: 'name' unless specified" if p["name_property"]
         text << " # default value: #{pretty_default(p["default"])}" unless pretty_default(p["default"]).nil?
         text << "\n"
       end
-      text << "    #{"action".ljust(padding_size)}Symbol # defaults to :#{@default_action.first} if not specified\n"
-      text << "  end"
+      text << "  #{"action".ljust(padding_size)}Symbol # defaults to :#{default_action.first} if not specified\n"
+      text << "end"
       text
     end
 
@@ -126,244 +120,62 @@ namespace :docs_site do
       end
     end
 
-    def boilerplate_content
-      <<~HEREDOC
-        Common Resource Functionality
-        =====================================================
-
-        Chef resources include common properties, notifications, and resource guards.
-
-        Common Properties
-        -----------------------------------------------------
-
-        .. tag resources_common_properties
-
-        The following properties are common to every resource:
-
-        ``ignore_failure``
-          **Ruby Type:** true, false | **Default Value:** ``false``
-
-          Continue running a recipe if a resource fails for any reason.
-
-        ``retries``
-          **Ruby Type:** Integer | **Default Value:** ``0``
-
-          The number of attempts to catch exceptions and retry the resource.
-
-        ``retry_delay``
-          **Ruby Type:** Integer | **Default Value:** ``2``
-
-          The retry delay (in seconds).
-
-        ``sensitive``
-          **Ruby Type:** true, false | **Default Value:** ``false``
-
-          Ensure that sensitive resource data is not logged by Chef Infra Client.
-
-        .. end_tag
-
-        Notifications
-        -----------------------------------------------------
-
-        ``notifies``
-          **Ruby Type:** Symbol, 'Chef::Resource[String]'
-
-          .. tag resources_common_notification_notifies
-
-          A resource may notify another resource to take action when its state changes. Specify a ``'resource[name]'``, the ``:action`` that resource should take, and then the ``:timer`` for that action. A resource may notify more than one resource; use a ``notifies`` statement for each resource to be notified.
-
-          .. end_tag
-
-        .. tag resources_common_notification_timers
-
-        A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
-
-        ``:before``
-           Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
-
-        ``:delayed``
-           Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
-
-        ``:immediate``, ``:immediately``
-           Specifies that a notification should be run immediately, per resource notified.
-
-        .. end_tag
-
-        .. tag resources_common_notification_notifies_syntax
-
-        The syntax for ``notifies`` is:
-
-        .. code-block:: ruby
-
-          notifies :action, 'resource[name]', :timer
-
-        .. end_tag
-
-        ``subscribes``
-          **Ruby Type:** Symbol, 'Chef::Resource[String]'
-
-        .. tag resources_common_notification_subscribes
-
-        A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a ``'resource[name]'``, the ``:action`` to be taken, and then the ``:timer`` for that action.
-
-        Note that ``subscribes`` does not apply the specified action to the resource that it listens to - for example:
-
-        .. code-block:: ruby
-
-         file '/etc/nginx/ssl/example.crt' do
-           mode '0600'
-           owner 'root'
-         end
-
-         service 'nginx' do
-           subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
-         end
-
-        In this case the ``subscribes`` property reloads the ``nginx`` service whenever its certificate file, located under ``/etc/nginx/ssl/example.crt``, is updated. ``subscribes`` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the ``:reload`` action for its resource (in this example ``nginx``) when a change is detected.
-
-        .. end_tag
-
-        .. tag resources_common_notification_timers
+    # build the menu entry for this resource
+    def build_menu_item(name)
+      menu = { 'docs' => {} }
+      menu['docs']['title'] = name
+      menu['docs']['identifier'] = "chef_infra/cookbook_reference/resources/#{name} #{name}"
+      menu['docs']['parent'] = 'chef_infra/cookbook_reference/resources'
+      menu['docs']['weight'] = @weight
 
-        A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
+      # increment weight by 10 for the next menu item
+      @weight += 10
 
-        ``:before``
-           Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
-
-        ``:delayed``
-           Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
-
-        ``:immediate``, ``:immediately``
-           Specifies that a notification should be run immediately, per resource notified.
-
-        .. end_tag
-
-        .. tag resources_common_notification_subscribes_syntax
-
-        The syntax for ``subscribes`` is:
-
-        .. code-block:: ruby
-
-           subscribes :action, 'resource[name]', :timer
-
-        .. end_tag
-
-        Guards
-        -----------------------------------------------------
-
-        .. tag resources_common_guards
-
-        A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:
-
-        * A string is executed as a shell command. If the command returns ``0``, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return ``true`` in addition to ``0``.
-        * A block is executed as Ruby code that must return either ``true`` or ``false``. If the block returns ``true``, the guard property is applied. If the block returns ``false``, the guard property is not applied.
-
-        A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.
-
-        .. end_tag
-
-        **Properties**
-
-        .. tag resources_common_guards_properties
-
-        The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:
-
-        ``not_if``
-          Prevent a resource from executing when the condition returns ``true``.
-
-        ``only_if``
-          Allow a resource to execute only if the condition returns ``true``.
-
-        .. end_tag
-      HEREDOC
+      menu
     end
 
-    template = %{=====================================================
-<%= @name %> resource
-=====================================================
-`[edit on GitHub] <https://github.com/chef/chef-web-docs/blob/master/chef_master/source/resource_<%= @name %>.rst>`__
-
-<%= bolded_description(@name, @description) %>
-<%= note_text(@description) -%>
-<% unless @introduced.nil? -%>
-
-**New in <%= branded_chef_client_name(@introduced) %> <%= @introduced %>.**
-<% end -%>
-
-Syntax
-=====================================================
-
-The <%= @name %> resource has the following syntax:
-
-.. code-block:: ruby
-
-<%= @resource_block %>
-
-where:
-
-* ``<%= @name %>`` is the resource.
-* ``name`` is the name given to the resource block.
-* ``action`` identifies which steps Chef Infra Client will take to bring the node into the desired state.
-<% unless @property_list.nil? %>* <%= @property_list %><% end %>
-
-Actions
-=====================================================
-
-The <%= @name %> resource has the following actions:
-<% @actions.each do |a| %>
-``:<%= a %>``
-   <% if a == @default_action %>Default. <% end %>Description here.
-<% end %>
-``:nothing``
-   .. tag resources_common_actions_nothing
-
-   This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run.
-
-   .. end_tag
-
-Properties
-=====================================================
-
-The <%= @name %> resource has the following properties:
-<% @properties.each do |p| %>
-``<%= p['name'] %>``
-   **Ruby Type:** <%= friendly_types_list(p['is']) %><% unless pretty_default(p['default']).nil? %> | **Default Value:** ``<%= pretty_default(p['default']) %>``<% end %><% if p['required'] %> | ``REQUIRED``<% end %><% if p['deprecated'] %> | ``DEPRECATED``<% end %><% if p['name_property'] %> | **Default Value:** ``The resource block's name``<% end %>
+    # the main method that builds what will become the yaml file
+    def build_resource_data(name, data)
+      properties = data["properties"].reject { |v| v["name"] == "name" }.sort_by! { |v| v["name"] }
+
+      r = {}
+      r['title'] = "#{name} resource"
+      r['resource'] = name
+      r['draft'] = false
+      r['aliases'] = ["/resource_#{name}.html"]
+      r['menu'] = build_menu_item(name)
+      r['resource_reference'] = true
+      r['robots'] = nil
+      r['resource_description_list'] = {}
+      r['resource_description_list']['markdown'] = data['description']
+      r['resource_new_in'] = data["introduced"]
+      r['handler_types'] = false
+      r['syntax_description'] = generate_resource_block(name, properties, data["default_action"])
+      r['handler_types'] = false
+      r['syntax_code_block'] = nil
+      r['syntax_properties_list'] = friendly_properly_list(properties)
+
+      #require 'pry'; binding.pry
+      r
+    end
 
-<% unless p['description'].nil? %>   <%= p['description'].strip %><% end %>
-<% unless p['introduced'].nil? -%>\n\n   *New in <%= branded_chef_client_name(p['introduced']) %> <%= p['introduced'] -%>.*\n<% end -%>
-<% end %>
-<% if @properties.empty? %>This resource does not have any properties.\n<% end -%>
-<%= boilerplate_content %>
-Examples
-=====================================================
+    FileUtils.mkdir_p "docs_site"
+    resources = Chef::JSONCompat.parse(ResourceInspector.inspect)
 
-The following examples demonstrate various approaches for using resources in recipes:
+    # sort the hash so we can generate the menu weights later
+    resources = Hash[resources.sort]
 
-<%= @examples -%>
-}
+    # weight is used to build the menu order. We start at 10 and increment by 10 each time
+    @weight = 10
 
-    FileUtils.mkdir_p "docs_site"
-    resources = Chef::JSONCompat.parse(ResourceInspector.inspect)
     resources.each do |resource, data|
+      # skip some resources we don't directly document
       next if ["scm", "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", ""].include?(resource)
 
       puts "Writing out #{resource}."
-      @name = resource
-      @description = data["description"]
-      @default_action = data["default_action"]
-      @actions = (data["actions"] - ["nothing"]).sort
-      @examples = data["examples"]
-      @introduced = data["introduced"]
-      @preview = data["preview"]
-      @properties = data["properties"].reject { |v| v["name"] == "name" }.sort_by! { |v| v["name"] }
-      @resource_block = generate_resource_block(resource, @properties)
-      @property_list = friendly_properly_list(@properties)
-      @examples = data["examples"]
-
-      t = ERB.new(template, nil, "-")
-      File.open("docs_site/resource_#{@name}.rst", "w") do |f|
-        f.write t.result(binding)
-      end
+      FileUtils.mkdir_p "docs_site/#{resource}"
+      File.open("docs_site/#{resource}/_index.md", "w") { |f| f.write(build_resource_data(resource, data).to_yaml) }
+
     end
   end
-end
+end
\ No newline at end of file