Merged change b5b368c4-b2e6-4e27-8b12-ae13114839ef

Delivery Server · Delivery Server · commit ab603cfb09bc · 2016-02-02T01:31:56.000Z
From review branch _reviews/master/topcommentupdates/1 into master

Signed-off-by: jscott &lt;jamescott@getchef.com&gt;
diff --git a/chef_master/source/config_rb_metadata.rst b/chef_master/source/config_rb_metadata.rst
@@ -6,6 +6,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_metadata_settings.rst
diff --git a/chef_master/source/workstation.rst b/chef_master/source/workstation.rst
@@ -21,7 +21,7 @@ Some important components of workstations include:
    * - :doc:`knife.rb </config_rb_knife>`
      - The |knife rb| file is used to specify the repository-specific configuration details for |knife|.
    * - :doc:`metadata.rb </config_rb_metadata>`
-     - Metadata is stored in a file called |metadata rb| that lives at the top of each cookbook’s directory.
+     - .. include:: ../../includes_cookbooks/includes_cookbooks_metadata.rst
 
 |chef dk_title|
 =====================================================
diff --git a/includes_config/includes_config_rb_metadata.rst b/includes_config/includes_config_rb_metadata.rst
@@ -2,6 +2,9 @@
 .. The contents of this file should be modified in a way that preserves its ability to appear in multiple topics.
 
 
-|config rb metadata| Metadata is compiled whenever a cookbook is uploaded to the |chef server| or when the ``knife cookbook metadata`` subcommand is run. |knife| creates a |metadata rb| file automatically whenever the ``knife cookbook create`` subcommand is run. In general, editing metadata should only be done using the |metadata rb| file, and then either by uploading the cookbook in which that |metadata rb| file is located to the |chef server| or by asking the |chef server| to recompile the metadata into |json| data.
+A |metadata rb| file is:
 
-.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+* Located at the top level of a cookbook's directory structure
+* Compiled whenever a cookbook is uploaded to the |chef server| or when the ``knife cookbook metadata`` subcommand is run, and then stored as |json data|
+* Created automatically by |knife| whenever the ``knife cookbook create`` subcommand is run
+* Edited using a text editor, and then re-uploaded to the |chef server| as part of a cookbook upload
diff --git a/includes_cookbooks/includes_cookbooks_metadata.rst b/includes_cookbooks/includes_cookbooks_metadata.rst
@@ -1,4 +1,4 @@
 .. 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.
 
-Every cookbook requires a small amount of metadata. Metadata is stored in a file called |metadata rb| that lives at the top of each cookbook's directory. The contents of the |metadata rb| file provides hints to the |chef server| so that cookbooks are deployed to each node correctly.
+Every cookbook requires a small amount of metadata. A file named |metadata rb| is located at the top of every cookbook directory structure. The contents of the |metadata rb| file provides hints to the |chef server| to help ensure that cookbooks are deployed to each node correctly.
diff --git a/includes_notes/includes_notes_metadata_json.rst b/includes_notes/includes_notes_metadata_json.rst
@@ -2,4 +2,4 @@
 .. The contents of this file should be modified in a way that preserves its ability to appear in multiple topics.
 
 
-A |metadata json| file can be edited directly, should temporary changes be required. Any subsequent upload or action that generates metadata will cause the existing |metadata json| file to be overwritten with the newly generated metadata. Therefore, any permanent change to metadata that is required should only be made in the |metadata rb| file.
+A |metadata json| file can be edited directly, should temporary changes be required. Any subsequent upload or action that generates metadata will cause the existing |metadata json| file to be overwritten with the newly generated metadata. Therefore, any permanent changes to cookbook metadata should be done in the |metadata rb| file, and then re-uploaded to the |chef server|.
diff --git a/release_chef_11-0/source/config_rb_metadata.rst b/release_chef_11-0/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-10/source/config_rb_metadata.rst b/release_chef_11-10/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-12/source/config_rb_metadata.rst b/release_chef_11-12/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-14/source/config_rb_metadata.rst b/release_chef_11-14/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-16/source/config_rb_metadata.rst b/release_chef_11-16/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-18/source/config_rb_metadata.rst b/release_chef_11-18/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-2/source/config_rb_metadata.rst b/release_chef_11-2/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-4/source/config_rb_metadata.rst b/release_chef_11-4/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-6/source/config_rb_metadata.rst b/release_chef_11-6/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_11-8/source/config_rb_metadata.rst b/release_chef_11-8/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 
diff --git a/release_chef_12-0/source/config_rb_metadata.rst b/release_chef_12-0/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/release_chef_12-1/source/config_rb_metadata.rst b/release_chef_12-1/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/release_chef_12-2/source/config_rb_metadata.rst b/release_chef_12-2/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/release_chef_12-3/source/config_rb_metadata.rst b/release_chef_12-3/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/release_chef_12-4/source/config_rb_metadata.rst b/release_chef_12-4/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/release_chef_12-5/source/config_rb_metadata.rst b/release_chef_12-5/source/config_rb_metadata.rst
@@ -8,6 +8,8 @@
 
 .. include:: ../../includes_config/includes_config_rb_metadata.rst
 
+.. note:: .. include:: ../../includes_notes/includes_notes_metadata_json.rst
+
 Settings
 ==========================================================================
 .. include:: ../../includes_config/includes_config_rb_12-5_metadata_settings.rst
diff --git a/swaps/swap_descriptions.txt b/swaps/swap_descriptions.txt
@@ -215,7 +215,6 @@
 .. |config rb chef server| replace:: A |chef server rb| file is used to specify the configuration settings for the |chef server|.
 .. |config rb client| replace:: A |client rb| file is used to specify the configuration details for the |chef client|.
 .. |config rb knife| replace:: A |knife rb| file is used to specify the |chef repo|-specific configuration details for |knife|.
-.. |config rb metadata| replace:: A |metadata rb| file is never interpreted directly. Rather, the |metadata rb| file provides a simple location to store and edit data that is then compiled by the |chef server| and stored as |json| data.
 .. |config rb server| replace:: A |server rb| file is used to specify the configuration details for the |chef server|.
 .. |config rb solo| replace:: A |solo rb| file is used to specify the configuration details for |chef solo|.
 .. |config rb solr| replace:: A |solr rb| file is used to specify the configuration details for |chef solr|, |chef solr indexer|, and |chef solr rebuild|.

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`	`.. The contents of this file should be modified in a way that preserves its ability to appear in multiple topics.`
`3`	`3`
`4`	`4`
`5`		`-A \|metadata json\| file can be edited directly, should temporary changes be required. Any subsequent upload or action that generates metadata will cause the existing \|metadata json\| file to be overwritten with the newly generated metadata. Therefore, any permanent change to metadata that is required should only be made in the \|metadata rb\| file.`
	`5`	`+A \|metadata json\| file can be edited directly, should temporary changes be required. Any subsequent upload or action that generates metadata will cause the existing \|metadata json\| file to be overwritten with the newly generated metadata. Therefore, any permanent changes to cookbook metadata should be done in the \|metadata rb\| file, and then re-uploaded to the \|chef server\|.`