sync up windows methods for recipe DSL

jamescott · jamescott · commit 6f5a2c279bf7 · 2016-02-01T18:01:15.000-08:00
diff --git a/chef_master/source/dsl_recipe.rst b/chef_master/source/dsl_recipe.rst
@@ -370,9 +370,9 @@ Send Email
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/chef_master/source/windows.rst b/chef_master/source/windows.rst
@@ -12,7 +12,7 @@ The |chef client| has specific components that are designed to support unique as
 * Two |knife| plugins dedicated to the |windows| platform are available: |subcommand knife azure| is used to manage virtual instances in |azure|; |subcommand knife windows| is used to interact with and manage physical nodes that are running |windows|, such as desktops and servers
 * Four cookbooks provide application-specific support. For `PowerShell 4.0 <https://github.com/chef-cookbooks/powershell>`_. For `IIS 7.0/7.5/8.0 <https://github.com/chef-cookbooks/iis>`_. For `SQL Server <https://github.com/chef-cookbooks/database>`_. And for configuring various settings and behaviors on a machine that is running `Windows <https://github.com/chef-cookbooks/windows>`_ 
 * Support for both :i386 and :x86_64 architectures
-* Six helpers are present in the |dsl recipe| to help verify the registry during a |chef client| run---``registry_data_exists?``, ``registry_get_subkeys``, ``registry_get_values``, ``registry_has_subkeys?``, ``registry_key_exists?``, and ``registry_value_exists?``---these helpers ensure the |resource powershell_script| resource is idempotent
+* .. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_helpers.rst
 * Two community provisioners for |kitchen|: `kitchen-dsc <https://github.com/smurawski/kitchen-dsc>`_ and `kitchen-pester <https://github.com/smurawski/kitchen-pester>`_
 
 The most popular core resources in the |chef client|---:doc:`cookbook_file </resource_cookbook_file>`, :doc:`directory </resource_directory>`, :doc:`env </resource_env>`, :doc:`execute </resource_execute>`, :doc:`file </resource_file>`, :doc:`group </resource_group>`, :doc:`http_request </resource_http_request>`, :doc:`link </resource_link>`, :doc:`mount </resource_mount>`, :doc:`package </resource_package>`, :doc:`remote_directory </resource_remote_directory>`, :doc:`remote_file </resource_remote_file>`, :doc:`ruby_block </resource_ruby_block>`, :doc:`service </resource_service>`, :doc:`template </resource_template>`, and :doc:`user </resource_user>`---work the same way in |windows| as they do on any |unix|- or |linux|-based platform.
@@ -23,7 +23,6 @@ The file-based resources---|resource cookbook_file|, |resource file|, |resource
 
 The following sections are pulled in from the larger |url docs| site and represents the documentation that is specific to the |windows| platform, compiled here into a single-page reference.
 
-
 Install the |chef client_title| on Windows
 =====================================================
 .. include:: ../../includes_windows/includes_windows_install_overview.rst
@@ -804,7 +803,9 @@ Some of the most popular |company_name|-maintained cookbooks that contain lightw
 
 |dsl recipe| Methods
 =====================================================
-.. include:: ../../includes_dsl_recipe/includes_dsl_recipe.rst
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
+
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst b/includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
@@ -0,0 +1,5 @@
+.. The contents of this file may be included in multiple topics (using the includes directive).
+.. The contents of this file should be modified in a way that preserves its ability to appear in multiple topics.
+
+
+Six methods are present in the |dsl recipe| to help verify the registry during a |chef client| run on the |windows| platform---``registry_data_exists?``, ``registry_get_subkeys``, ``registry_get_values``, ``registry_has_subkeys?``, ``registry_key_exists?``, and ``registry_value_exists?``---these helpers ensure the |resource powershell_script| resource is idempotent.
diff --git a/includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst b/includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
@@ -0,0 +1,5 @@
+.. The contents of this file may be included in multiple topics (using the includes directive).
+.. The contents of this file should be modified in a way that preserves its ability to appear in multiple topics.
+
+
+The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
diff --git a/release_chef_11-0/source/dsl_recipe.rst b/release_chef_11-0/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-10/source/dsl_recipe.rst b/release_chef_11-10/source/dsl_recipe.rst
@@ -231,9 +231,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-12/source/dsl_recipe.rst b/release_chef_11-12/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-14/source/dsl_recipe.rst b/release_chef_11-14/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-16/source/dsl_recipe.rst b/release_chef_11-16/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-18/source/dsl_recipe.rst b/release_chef_11-18/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-2/source/dsl_recipe.rst b/release_chef_11-2/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-4/source/dsl_recipe.rst b/release_chef_11-4/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-6/source/dsl_recipe.rst b/release_chef_11-6/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_11-8/source/dsl_recipe.rst b/release_chef_11-8/source/dsl_recipe.rst
@@ -233,9 +233,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
diff --git a/release_chef_12-0/source/dsl_recipe.rst b/release_chef_12-0/source/dsl_recipe.rst
@@ -249,9 +249,9 @@ value_for_platform_family
 
 Windows Platform
 =====================================================
-The following methods and helpers may be used on the |windows| platform:
+.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
 
-.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
+.. note:: .. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
 
 registry_data_exists?
 -----------------------------------------------------
