Merge pull request microsoft#19 from barbkess/blk

barbkess · barbkess · commit a4ca8b9d5be0 · 2016-04-29T21:58:55.000-07:00
Blk
diff --git a/README_samples_template.md b/README_samples_template.md
@@ -1,72 +1,92 @@
-# Ticket Reservations Sample
+# Sample name
 
-Ticket Reservations is a Windows Forms sample application built on .NET Framework 4.6 that demonstrates the performance benefits of using SQL Server memory optimized tables and native compiled stored procedures. You can compare the performance before and after enabling In-Memory OLTP by observing the transactions/sec as well as the current CPU Usage and latches/sec.
+Briefly describe what the sample does. Describe the benefit of running this sample.
 
-![Alt text](samples/features/in-memory/ticket-reservations/Screenshots/1.png "Ticket Reservations")
+<!-- Add a diagram if you have it -->
 
+![Alt text](/media/image-name.png "<Friendly name>")
 
-## Applies
 
-**Platforms:**
-- SQL Server (starting with 2016)
-- Azure SQL Database
+### Contents
 
-**Features:**
-- In-memory OLTP
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
 
-**Languages:**
 
-- TSQL
-- C#
+<a name=about-this-sample></a>
 
+## About this sample
 
-## Running this sample
-1. Before you can run this sample, you must have the following perquisites:
-	- SQL Server 2016 CTP3 (or higher)
-	- Visual Studio 2015 (or higher) with the latest SSDT installed.
+Applies to:
 
-2. Clone this repository using Git for Windows (http://www.git-scm.com/), or download the zip file.
+- SQL Server 2016 (or higher), or Azure SQL Data Warehouse
 
-3. From Visual Studio, open the **InMemoryOLTPDemo.sln** file from the root directory.
+Key features:
 
-4. In Visual Studio Build menu, select **Build Solution** (or Press F6).
+- columnstore indexes
 
-5. In the **App.config** file, located in the project root, find the **TicketReservations** app setting and edit the connectionString if needed. Currently it is configured to connect to the local default SQL Server Instance using Integrated Security.
+Workload:
+- data warehouse
 
-6. Publish the TicketReservations Database
-  - Right click on the TicketReservations SQL Server Database Project and Select **Publish**
-  - Click Edit... to choose your connection string
-  - Click Publish
-  - Note: For publishing to Azure SQL you need to change the DB project target platform to **Microsoft Azure SQL Database V12**
+Languages:
 
-7. You can now run and debug the application locally by pressing **F5** in Visual Studio.
+- T-SQL
 
-8. Start the workload with the **Start** button, and run for a while to show perf profile. Then press stop to stop the workload.
+Authors:
 
-9. In the database project,
-	- Change TicketReservations.sql to a memory-optimized table (instructions commented in the file itself)
-	- Change InsertTicketReservations.sql to natively compiled (instructions in the same file)
+- github-user1;github-user2
 
-10. Publish the database project to the same database – the tool will take care of making the necessary changes.
-		Note that, as part of publication, the data is copied from the old disk-based table to the new memory-optimized table, so the longer you run the initial workload, the longer this publication takes.
+Last update:
 
-11. Go back to the app and run the workload again. No need to recompile or restart the application.
+- 04/29/2016
 
-The perf gains from In-Memory OLTP as shown by the load generation app depend on two factors:
--	Hardware
-  -	more cores => higher perf gain
-  -	slower log IO => lower perf gain
--	Configuration settings in the load generator
-  -	more rows per transaction => higher perf gain
-  -	more reads per write => lower perf gain
-  -	default setting is 10 rows per transaction and 1 read per write
+<a name=before-you-begin></a>
 
-With default settings on one machine with 24 logical cores and relatively slow SSD for the log the app shows around performance 40X gain, and in this case the bottleneck was log IO.
+## Before you begin
 
+To run this sample, you need the following prerequisites.
 
-## About the code
-The code included in this sample is not intended to be a set of best practices on how to build scalable enterprise grade web applications. This is beyond the scope of this quick start sample.
+Software prerequisites:
 
-## More information
-- [In-Memory OLTP (In-Memory Optimization)] (https://msdn.microsoft.com/en-us/library/dn133186.aspx)
-- [OLTP and database management] (https://www.microsoft.com/en-us/server-cloud/solutions/oltp-database-management.aspx)
+<!-- Examples -->
+1. SQL Server 2016 (or higher) or an Azure SQL Database
+2. Visual Studio 2015 (or higher) with the latest SSDT installed
+
+Azure prerequisites:
+
+<!-- Examples -->
+1. Permission to create an Azure SQL Database
+
+<a name=run-this-sample></a>
+
+## Run this sample
+
+<!-- Step by step instructions. Here's a few examples -->
+
+1. From Visual Studio, open the **sample.sln** file from the root directory.
+
+2. In Visual Studio Build menu, select **Build Solution** (or Press F6).
+
+3. Step 3 ... 
+
+<a name=sample-details></a>
+
+## Sample details
+
+Describe sample details
+
+<a name=disclaimers></a>
+
+## Disclaimers
+The code included in this sample is not intended to be ...
+
+<a name=related-links></a>
+
+## Related Links
+<!-- Links to more articles. Remember to delete "en-us" from the link path. -->
+
+For more information, see these articles:
