Adding preview/stable to the example layout.

README.md

@@ -33,17 +33,19 @@ The structure of the directory should strictly follow these rules:
 
 1. **Profile**: The profile holder contains the profiles' definition MD files. these files will contain information and references to the snapshots of the RPs' Resource types or Dataplane API versions that represent a specific profile.
 
-2. **Specification**: This folder the is root folder for all Specs (Management and Dataplane) related docs.
+1. **Specification**: This folder the is root folder for all Specs (Management and Dataplane) related docs.
 
-3. **<RP-Name>** Folders - each RP will have a separate folder
+1. **{RP-Name} Folders** - each RP will have a separate folder
 
-4. **'resource-manager' and 'data-plane' Folders**: the RPs can put specs in one of two categories: `resource-manager` (for ARM resources) and `data-plane` (for everything else) . The autorest configuration file (`readme.md`) for the RP should be inside this folder
+1. **'resource-manager' and 'data-plane' Folders**: the RPs can put specs in one of two categories: `resource-manager` (for ARM resources) and `data-plane` (for everything else) . The autorest configuration file (`readme.md`) for the RP should be inside this folder
 
-4. **API versions**: this folder will be the direct child of the category folder. there will be one such folder per resource type or dataplane service version. This folder will contain the OpenAPI validation Specs (Swaggers previously) and the examples folder.
+1. **'preview' and 'stable' Folders**: Varying levels of stability exist in our repository. Each API Version folder should be categorized as either still accepting breaking changes, or no longer accepting breaking changes. This is not a direct analog for whether or not an API Version has the "-preview" suffix or not. SDKs that are generated from 'preview' folder items should indicate to their customers in the most idiomatic way that breaking changes may still be coming.
 
-6. **Examples**: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples.
+1. **API versions**: this folder will be the direct child of the category folder. there will be one such folder per resource type or dataplane service version. This folder will contain the OpenAPI validation Specs (Swaggers previously) and the examples folder.
 
-7. **Notes**:
+1. **Examples**: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples.
+
+1. **Notes**:
     - folder names should be singular (ie, 'profile' not 'profiles' ) -- this removes ambiguity for some non-english speakers.
     - generic folder names should be lower-case
     - proper-name/product name/namespace folders can be PascalCased (ie, "KeyVault")
@@ -57,31 +59,37 @@ The structure should appear like so:
 |    +---automation
 |    |   \---resource-manager
 |    |       \---Microsoft.Automation
-|    |           \---2015-10-31
-|    |               \---examples
+|    |           \---stable
+|    |               \---2015-10-31
+|    |                   \---examples
 |    +---batch
 |    |   +---data-plane
 |    |   |   \---Microsoft.Batch
-|    |   |       +---2015-12-01.2.2
-|    |   |       +---2016-02-01.3.0
-|    |   |       +---2016-07-01.3.1
-|    |   |       +---2017-01-01.4.0
-|    |   |       |   \---examples
-|    |   |       \---2017-05-01.5.0
+|    |   |       +---stable
+|    |   |       |   +---2015-12-01.2.2
+|    |   |       |   +---2016-02-01.3.0
+|    |   |       |   +---2016-07-01.3.1
+|    |   |       |   +---2017-01-01.4.0
+|    |   |       |       \---examples
+|    |   |       \---preview
+|    |   |           \---2017-05-01.5.0
 |    |   \---resource-manager
 |    |       \---Microsoft.Batch
-|    |           +---2015-12-01
-|    |           +---2017-01-01
-|    |           |   \---examples
+|    |           +---stable
+|    |           |   +---2015-12-01
+|    |           |   +---2017-01-01
+|    |           |       \---examples
 |    |           \---2017-05-01
 |    |               \---examples
 |    +---billing
 |        \---resource-manager
 |            \---Microsoft.Billing
-|                +---2017-02-27-preview
-|                |   \---examples
-|                \---2017-04-24-preview
-|                    \---examples
+|                \---stable
+|                |   +---2017-02-27-preview
+|                |       \---examples
+|                +---preview
+|                    \---2017-04-24-preview
+|                        \---examples
 \--- readme.md
 ```