Reorganize getting started guides into platform-specific folders

docs/getting-started/index.rst → docs/getting-started.rst

@@ -8,11 +8,8 @@ Entity Framework can be used in a variety of different .NET applications. The fo
 Available Tutorials
 -------------------
 
-.. toctree::
-    :titlesonly:
-
-    full-dotnet/index
-    aspnet5/index
-    uwp/index
-    osx
-    linux
+ - :doc:`platforms/full-dotnet/getting-started`
+ - :doc:`platforms/aspnetcore/getting-started`
+ - :doc:`platforms/uwp/getting-started`
+ - :doc:`platforms/coreclr/getting-started-osx`
+ - :doc:`platforms/coreclr/getting-started-linux`

docs/index.rst

@@ -5,8 +5,10 @@ Entity Framework Documentation
 
 .. toctree::
     :titlesonly:
+    :maxdepth: 2
 
-    getting-started/index
+    getting-started
+    platforms/index
     providers/index
     modeling/index
     cli/index

docs/getting-started/_shared/create-blogging-database-vs.txt → docs/platforms/_shared/create-blogging-database-vs.txt

@@ -10,6 +10,6 @@
 * Copy the script, listed below, into the query editor
 * Right-click on the query editor and select **Execute**
 
-.. literalinclude:: /getting-started/_shared/create-blogging-database-script.sql
+.. literalinclude:: /platforms/_shared/create-blogging-database-script.sql
         :language: sql
         :linenos:

docs/getting-started/aspnet5/existing-db.rst → docs/platforms/aspnetcore/existing-db.rst

@@ -10,7 +10,7 @@ In this walkthrough, you will build an ASP.NET 5 MVC application that performs b
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/aspnet5/sample
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/aspnetcore/sample
 
 Prerequisites
 -------------
@@ -26,7 +26,7 @@ Blogging database
 
 This tutorial uses a **Blogging** database on your LocalDb instance as the existing database.
 
-.. include:: /getting-started/_shared/create-blogging-database-vs.txt
+.. include:: /platforms/_shared/create-blogging-database-vs.txt
 
 Create a new project
 --------------------

docs/getting-started/aspnet5/index.rst → docs/platforms/aspnetcore/getting-started.rst

@@ -1,9 +1,9 @@
-Getting Started on ASP.NET 5
-============================
+Getting Started on ASP.NET Core
+===============================
 
 These 101 tutorials require no previous knowledge of Entity Framework (EF) or Visual Studio. They will take you step-by-step through creating a simple application that queries and saves data from a database.
 
-Entity Framework can create a model based on an existing database, or create a database for you based on your model. The following tutorials will demonstrate both of these approaches using an ASP.NET 5 application.
+Entity Framework can create a model based on an existing database, or create a database for you based on your model. The following tutorials will demonstrate both of these approaches using an ASP.NET Core application.
 
 Available Tutorials
 -------------------

docs/platforms/aspnetcore/index.rst

@@ -0,0 +1,10 @@
+ASP.NET Core
+============
+
+These articles provide documentation for using EF with ASP.NET Core.
+
+.. toctree::
+    :titlesonly:
+    :caption: The following articles are available
+
+    getting-started

docs/getting-started/aspnet5/new-db.rst → docs/platforms/aspnetcore/new-db.rst

@@ -10,7 +10,7 @@ In this walkthrough, you will build an ASP.NET 5 MVC application that performs b
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/aspnet5/sample
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/aspnetcore/sample
 
 Prerequisites
 -------------

docs/getting-started/aspnet5/sample/EFGetStarted.AspNet5.sln → docs/platforms/aspnetcore/sample/EFGetStarted.AspNet5.sln

@@ -1,39 +1,39 @@
-
-Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 14
-VisualStudioVersion = 14.0.24711.0
-MinimumVisualStudioVersion = 10.0.40219.1
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A60252AF-A287-4AC1-9A99-85D172B1261B}"
-EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0ABBD435-7E7A-4759-974D-12DEC774F341}"
-	ProjectSection(SolutionItems) = preProject
-		global.json = global.json
-	EndProjectSection
-EndProject
-Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "EFGetStarted.AspNet5.NewDb", "src\EFGetStarted.AspNet5.NewDb\EFGetStarted.AspNet5.NewDb.xproj", "{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}"
-EndProject
-Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "EFGetStarted.AspNet5.ExistingDb", "src\EFGetStarted.AspNet5.ExistingDb\EFGetStarted.AspNet5.ExistingDb.xproj", "{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}"
-EndProject
-Global
-	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|Any CPU = Debug|Any CPU
-		Release|Any CPU = Release|Any CPU
-	EndGlobalSection
-	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Release|Any CPU.Build.0 = Release|Any CPU
-		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Release|Any CPU.Build.0 = Release|Any CPU
-	EndGlobalSection
-	GlobalSection(SolutionProperties) = preSolution
-		HideSolutionNode = FALSE
-	EndGlobalSection
-	GlobalSection(NestedProjects) = preSolution
-		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296} = {A60252AF-A287-4AC1-9A99-85D172B1261B}
-		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2} = {A60252AF-A287-4AC1-9A99-85D172B1261B}
-	EndGlobalSection
-EndGlobal
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 14
+VisualStudioVersion = 14.0.24711.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A60252AF-A287-4AC1-9A99-85D172B1261B}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0ABBD435-7E7A-4759-974D-12DEC774F341}"
+	ProjectSection(SolutionItems) = preProject
+		global.json = global.json
+	EndProjectSection
+EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "EFGetStarted.AspNet5.NewDb", "src\EFGetStarted.AspNet5.NewDb\EFGetStarted.AspNet5.NewDb.xproj", "{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}"
+EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "EFGetStarted.AspNet5.ExistingDb", "src\EFGetStarted.AspNet5.ExistingDb\EFGetStarted.AspNet5.ExistingDb.xproj", "{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{5C6C4170-4D3F-4981-B4BD-FB164EB7E296} = {A60252AF-A287-4AC1-9A99-85D172B1261B}
+		{1DC1B162-DC5D-427A-AFF9-0CFD4D8FC1F2} = {A60252AF-A287-4AC1-9A99-85D172B1261B}
+	EndGlobalSection
+EndGlobal

docs/getting-started/aspnet5/sample/global.json → docs/platforms/aspnetcore/sample/global.json

@@ -1,6 +1,6 @@
-{
-  "projects": [ "src", "test" ],
-  "sdk": {
-    "version": "1.0.0-rc1-final"
-  }
-}
+{
+  "projects": [ "src", "test" ],
+  "sdk": {
+    "version": "1.0.0-rc1-final"
+  }
+}

docs/getting-started/linux.rst → docs/platforms/coreclr/getting-started-linux.rst

@@ -11,7 +11,7 @@ the SQLite provider.
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/x-plat/sample
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/coreclr/sample
 
 Prerequisites
 -------------
@@ -22,7 +22,7 @@ Minimum system requirements
 .. caution::
     **Known Issues**
 
-    .. include:: x-plat/issues.txt
+    .. include:: issues.txt
 
 
 Install ASP.NET 5
@@ -63,4 +63,4 @@ On Ubuntu 14, install the SQLite library.
 
         ~ $ sudo apt-get install libsqlite3-dev
 
-.. include:: x-plat/guide.txt
+.. include:: guide.txt

docs/getting-started/osx.rst → docs/platforms/coreclr/getting-started-osx.rst

@@ -1,7 +1,7 @@
 .. include:: /_shared/rc1-notice.txt
 
-Getting Started on OSX
-======================
+Getting Started on OS X
+=======================
 
 This walkthrough will create a simple console application using ASP.NET 5 and
 the SQLite provider.
@@ -11,7 +11,7 @@ the SQLite provider.
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/x-plat/sample
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/coreclr/sample
 
 Prerequisites
 -------------
@@ -22,7 +22,7 @@ Minimum system requirements
 .. caution::
     **Known Issues**
 
-    .. include:: x-plat/issues.txt
+    .. include:: issues.txt
 
 Install ASP.NET 5
 -----------------
@@ -53,4 +53,4 @@ The following steps will install `dnvm <https://github.com/aspnet/home#running-a
 If you have trouble installing dnvm, consult `Installing ASP.NET 5 on Mac OS X <http://docs.asp.net/en/latest/getting-started/installing-on-mac.html>`_.
 
 
-.. include:: x-plat/guide.txt
+.. include:: guide.txt

docs/getting-started/x-plat/guide.txt → docs/platforms/coreclr/guide.txt

@@ -9,7 +9,7 @@ Create a new project
 
  - Create a new file ``project.json`` with the following contents
 
-    .. literalinclude:: x-plat/sample/src/ConsoleApp/project.json
+    .. literalinclude:: sample/src/ConsoleApp/project.json
             :language: json
             :linenos:
 
@@ -85,15 +85,15 @@ blog post from the command line.
  - Create a new file called ``Model.cs``
     All classes in the following steps will be added to this file.
 
-        .. literalinclude:: x-plat/sample/src/ConsoleApp/Model.cs
+        .. literalinclude:: sample/src/ConsoleApp/Model.cs
             :language: c#
             :linenos:
             :lines: 1-7
 
  - Add a new class to represent the SQLite database.
     We will call this ``BloggingContext``. The call to ``UseSqlite()`` configures EF to point to a \*.db file in the same folder as the ``project.json`` file for our project.
 
-        .. literalinclude:: x-plat/sample/src/ConsoleApp/Model.cs
+        .. literalinclude:: sample/src/ConsoleApp/Model.cs
             :language: c#
             :linenos:
             :lines: 8-19
@@ -102,7 +102,7 @@ blog post from the command line.
  - Add classes to represent tables.
     Note that we will be using foreign keys to associate many posts to one blog.
 
-        .. literalinclude:: x-plat/sample/src/ConsoleApp/Model.cs
+        .. literalinclude:: sample/src/ConsoleApp/Model.cs
             :language: c#
             :linenos:
             :lines: 20-37
@@ -152,7 +152,7 @@ Use your model
 
 Now that we have configured our model and created the database schema, we can use BloggingContext to create, update, and delete objects.
 
-.. literalinclude:: x-plat/sample/src/ConsoleApp/Program.cs
+.. literalinclude:: sample/src/ConsoleApp/Program.cs
     :language: c#
     :linenos:
 

docs/platforms/coreclr/index.rst

@@ -0,0 +1,11 @@
+.NET Core (CoreCLR)
+===================
+
+EF can be used on all platforms (Windows, OSX, Linux, etc.) that support .NET Core.
+
+.. toctree::
+  :titlesonly:
+  :caption: The following articles are available
+
+  getting-started-linux
+  getting-started-osx

docs/getting-started/full-dotnet/existing-db.rst → docs/platforms/full-dotnet/existing-db.rst

@@ -10,7 +10,7 @@ In this walkthrough, you will build a console application that performs basic da
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/full-dotnet/sample/EFGetStarted.ConsoleApp.ExistingDb
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/full-dotnet/sample/EFGetStarted.ConsoleApp.ExistingDb
 
 Prerequisites
 -------------
@@ -32,7 +32,7 @@ Blogging database
 
 This tutorial uses a **Blogging** database on your LocalDb instance as the existing database.
 
-.. include:: /getting-started/_shared/create-blogging-database-vs.txt
+.. include:: /platforms/_shared/create-blogging-database-vs.txt
 
 Create a new project
 --------------------

docs/platforms/full-dotnet/index.rst

@@ -0,0 +1,10 @@
+Full .NET Framework
+===================
+
+These articles provide documentation for using EF on the full .NET Framework (Console, WinForms, WPF, etc.).
+
+.. toctree::
+    :titlesonly:
+    :caption: The following articles are available
+
+    getting-started

docs/getting-started/full-dotnet/new-db.rst → docs/platforms/full-dotnet/new-db.rst

@@ -10,7 +10,7 @@ In this walkthrough, you will build a console application that performs basic da
     :local:
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/full-dotnet/sample/EFGetStarted.ConsoleApp.NewDb
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/full-dotnet/sample/EFGetStarted.ConsoleApp.NewDb
 
 Prerequisites
 -------------

docs/platforms/index.rst

@@ -0,0 +1,14 @@
+Platforms
+=========
+
+The following articles provide documentation for using EF on different platforms.
+
+.. toctree::
+  :titlesonly:
+  :caption: The following platforms are available
+  :maxdepth: 1
+
+  full-dotnet/index
+  coreclr/index
+  aspnetcore/index
+  uwp/index

docs/getting-started/uwp/getting-started.rst → docs/platforms/uwp/getting-started.rst

@@ -32,7 +32,7 @@ In this article:
 	- `Use your model`_
 
 .. include:: /_shared/sample.txt
-.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/getting-started/uwp/sample
+.. _sample: https://github.com/aspnet/EntityFramework.Docs/tree/master/docs/platforms/uwp/sample
 
 Prerequisites
 -------------