📝 More visible docs on installing

Also tidying up some of the provider docs to use a more consistent format etc.
dotnet · Jun 29, 2016 · fc42d27 · fc42d27
1 parent 55df04f
commit fc42d27
Show file tree

Hide file tree

Showing 9 changed files with 151 additions and 129 deletions.
diff --git a/docs/_shared/intro.txt b/docs/_shared/intro.txt
@@ -4,6 +4,15 @@ EF Core is an object-relational mapper (O/RM) that enables .NET developers to wo
 
 If you like to learn by writing code, we'd recommend one of our :doc:`platforms/index` guides to get you started with EF Core.
 
+Get Entity Framework Core
+-------------------------
+
+`Install the NuGet package <https://docs.nuget.org/consume>`_ for the database provider you want to use. See :doc:`/providers/index` for information.
+
+.. code-block:: text
+
+    PM>  Install-Package Microsoft.EntityFrameworkCore.SqlServer
+
 The Model
 ---------
 

diff --git a/docs/providers/devart/index.rst b/docs/providers/devart/index.rst
@@ -1,6 +1,11 @@
 DevArt (MySQL, Oracle, PostgreSQL, DB2, SQL Server, and more)
 =============================================================
 
+DevArt is a third party provider writer that offers database providers for a wide range of databases. Find out more at `devart.com/dotconnect <https://www.devart.com/dotconnect/>`_.
+
+.. caution::
+    DevArt dotConnect currently only supports the Entity Framework Core RC2 pre-release.
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
@@ -10,32 +15,27 @@ Paid Versions Only
 
 DevArt dotConnect is a commercial third party provider. Entity Framework support is only available in paid versions of dotConnect.
 
-Getting Started
----------------
+Install
+-------
+
+See the `DevArt dotConnect documentation <https://www.devart.com/dotconnect/>`_ for installation instructions.
+
+Get Started
+-----------
 
-See the `DevArt dotConnect documentation <https://www.devart.com/dotconnect/>`_ to get started.
+See the `DevArt dotConnect Entity Framework documentation <https://www.devart.com/dotconnect/entityframework.html>`_ to get started.
 
 Supported Database Engines
 --------------------------
 
-* MySQL
-* Oracle
-* PostgreSQL
-* DB2
-* SQL Server
-* and more...
+  * MySQL
+  * Oracle
+  * PostgreSQL
+  * DB2
+  * SQL Server
+  * and more...
 
 Supported Platforms
 -------------------
 
-* Full .NET (4.5.1 onwards)
-
-Status
-------
-
-Pre-release available (supports RC2), see the `DevArt dotConnect documentation <https://www.devart.com/dotconnect/>`_ for details.
-
-Project Site
-------------
-
-See the `DevArt dotConnect site <https://www.devart.com/dotconnect/>`_ for issues, questions, etc.
+  * Full .NET (4.5.1 onwards)
diff --git a/docs/providers/ibm/index.rst b/docs/providers/ibm/index.rst
@@ -1,14 +1,28 @@
 IBM Data Servers
 ================
 
+This database provider allows Entity Framework Core to be used with IBM Data Servers. Issues, questions, etc. can be posted in the `.Net Development with DB2 and IDS forum <https://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000000467>`_
+
+.. caution::
+    This provider currently only supports the Entity Framework Core RC1 pre-release.
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
 
-Getting Started
----------------
+Install
+-------
+
+Install the `EntityFramework.IBMDataServer NuGet package <https://www.nuget.org/packages/EntityFramework.IBMDataServer>`_.
+
+.. code-block:: text
+
+    PM>  Install-Package EntityFramework.IBMDataServer -Pre
 
-The following resources will help you get started:
+Get Started
+-----------
+
+The following resources will help you get started with this provider.
  * `Sample application <https://www.ibm.com/developerworks/community/blogs/96960515-2ea1-4391-8170-b0515d08e4da/entry/sample_ef7_application_for_ibm_data_servers>`_
  * `Updates & Limitations <https://www.ibm.com/developerworks/community/blogs/96960515-2ea1-4391-8170-b0515d08e4da/entry/latest_updates_and_limitations_for_ibm_data_server_entityframework_7>`_
 
@@ -21,13 +35,3 @@ Supported Platforms
 -------------------
 
  * Full .NET (4.5.1 onwards)
-
-Status
-------
-
-`Pre-release EntityFramework.IBMDataServer package on NuGet.org (supports RC1) <https://www.nuget.org/packages/EntityFramework.IBMDataServer/>`_
-
-Project Site
-------------
-
-Issues, questions, etc. can be posted in the `.Net Development with DB2 and IDS forum <https://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000000467>`_
diff --git a/docs/providers/in-memory/index.rst b/docs/providers/in-memory/index.rst
@@ -1,21 +1,32 @@
-InMemory (for testing)
+InMemory (for Testing)
 ======================
 
+This database provider allows Entity Framework Core to be used with an in-memory database. This is useful when testing code that uses Entity Framework Core. The provider is maintained as part of the `EntityFramework GitHub project <https://github.com/aspnet/EntityFramework>`_.
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
 
-Getting Started
----------------
+Install
+-------
+
+Install the `Microsoft.EntityFrameworkCore.InMemory NuGet package <hhttps://www.nuget.org/packages/Microsoft.EntityFrameworkCore.InMemory/>`_.
+
+.. code-block:: text
+
+    PM>  Install-Package Microsoft.EntityFrameworkCore.InMemory
 
-See :doc:`/miscellaneous/testing`
+Get Started
+-----------
 
-The `tests for the UnicornStore sample application <https://github.com/rowanmiller/UnicornStore/blob/master/UnicornStore/src/UnicornStore.Tests/Controllers/ShippingControllerTests.cs>`_ also provide an example of using this provider.
+The following resources will help you get started with this provider.
+  * :doc:`/miscellaneous/testing`
+  * `UnicornStore Sample Application Tests <https://github.com/rowanmiller/UnicornStore/blob/master/UnicornStore/src/UnicornStore.Tests/Controllers/ShippingControllerTests.cs>`_
 
 Supported Database Engines
 --------------------------
 
-Built-in in-memory database (designed for testing purposes only)
+  * Built-in in-memory database (designed for testing purposes only)
 
 Supported Platforms
 -------------------
@@ -24,13 +35,3 @@ Supported Platforms
   * .NET Core
   * Mono (4.2.0 onwards)
   * Universal Windows Platform
-
-Status
-------
-
-`Microsoft.EntityFrameworkCore.InMemory package is available on NuGet.org <https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.InMemory>`_
-
-Project Site
-------------
-
-`EntityFramework GitHub project <https://github.com/aspnet/EntityFramework>`_
diff --git a/docs/providers/npgsql/index.rst b/docs/providers/npgsql/index.rst
@@ -1,33 +1,37 @@
 Npgsql (PostgreSQL)
 ===================
 
+This database provider allows Entity Framework Core to be used with PostgreSQL. The provider is maintained as part of the `Npgsql project <http://www.npgsql.org>`_.
+
+.. caution::
+    Npgsql currently only supports the Entity Framework Core RC2 pre-release.
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
 
-Getting Started
----------------
+Install
+-------
 
-See the `getting started documentation on the Npgsql site <http://www.npgsql.org/doc/ef7.html>`_
+Install the `Npgsql.EntityFrameworkCore.PostgreSQL NuGet package <https://www.nuget.org/packages/Npgsql.EntityFrameworkCore.PostgreSQL>`_.
 
-Supported Database Engines
---------------------------
+.. code-block:: text
 
-PostgreSQL
+    PM>  Install-Package Npgsql.EntityFrameworkCore.PostgreSQL -Pre
 
-Supported Platforms
--------------------
+Get Started
+-----------
 
- * Full .NET (4.5.1 onwards)
- * .NET Core
- * Mono (4.2.0 onwards)
+See the `Npgsql documentation <http://www.npgsql.org/doc/ef7.html>`_ to get started.
 
-Status
-------
+Supported Database Engines
+--------------------------
 
-`Pre-release Npgsql.EntityFrameworkCore.PostgreSQL package on NuGet.org (supports RC2) <https://www.nuget.org/packages/Npgsql.EntityFrameworkCore.PostgreSQL/>`_
+  * PostgreSQL
 
-Project Site
-------------
+Supported Platforms
+-------------------
 
-`Npgsql.org <http://www.npgsql.org>`_
+  * Full .NET (4.5.1 onwards)
+  * .NET Core
+  * Mono (4.2.0 onwards)
diff --git a/docs/providers/oracle/index.rst b/docs/providers/oracle/index.rst
@@ -1,6 +1,6 @@
 Oracle (Coming Soon)
 ====================
 
-We are working with the Oracle team to make an Oracle provider available. Please direct any questions about this provider, including the release timeline, to the `Oracle Community Site <https://community.oracle.com/>`_.
+The Oracle .NET team is evaluating EF Core support, but have not announced any timing. You can vote on the `Oracle EF Core Provider feature request <https://apex.oracle.com/pls/apex/f?p=18357:39:105422858407495::NO::P39_ID:28241>`_.
 
-DevArt dotConnect does offer a paid provider for Oracle, see :doc:`/providers/devart/index` for details.
+Please direct any questions about this provider, including the release timeline, to the `Oracle Community Site <https://community.oracle.com/>`_.
diff --git a/docs/providers/sql-compact/index.rst b/docs/providers/sql-compact/index.rst
@@ -1,34 +1,40 @@
 Microsoft SQL Server Compact Edition
 ====================================
 
+This database provider allows Entity Framework Core to be used with SQL Server Compact Edition. The provider is maintained as part of the `ErikEJ/EntityFramework.SqlServerCompact GitHub Project <https://github.com/ErikEJ/EntityFramework.SqlServerCompact>`_.
+
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
 
-Getting Started
----------------
+Install
+-------
+
+To work with SQL Server Compact Edition 4.0, install the `EntityFrameworkCore.SqlServerCompact40 NuGet package <https://www.nuget.org/packages/EntityFrameworkCore.SqlServerCompact40>`_.
+
+.. code-block:: text
+
+    PM>  Install-Package EntityFrameworkCore.SqlServerCompact40
+
+To work with SQL Server Compact Edition 3.5, install the `EntityFrameworkCore.SqlServerCompact35 <https://www.nuget.org/packages/EntityFrameworkCore.SqlServerCompact35>`_.
+
+.. code-block:: text
+
+    PM>  Install-Package EntityFrameworkCore.SqlServerCompact35
+
+Get Started
+-----------
 
 See the `getting started documentation on the project site <https://github.com/ErikEJ/EntityFramework.SqlServerCompact/wiki/Using-EF-Core-with-SQL-Server-Compact-in-Traditional-.NET-Applications>`_
 
 Supported Database Engines
 --------------------------
 
-* SQL Server Compact Edition 3.5
-* SQL Server Compact Edition 4.0
+  * SQL Server Compact Edition 3.5
+  * SQL Server Compact Edition 4.0
 
 Supported Platforms
 -------------------
 
- * Full .NET (4.5.1 onwards)
-
-Status
-------
-
-Packages are available on NuGet.org
- * `EntityFrameworkCore.SqlServerCompact35 <https://www.nuget.org/packages/EntityFrameworkCore.SqlServerCompact35>`_
- * `EntityFrameworkCore.SqlServerCompact40 <https://www.nuget.org/packages/EntityFrameworkCore.SqlServerCompact40>`_
-
-Project Site
-------------
-
-`ErikEJ/EntityFramework.SqlServerCompact GitHub Project <https://github.com/ErikEJ/EntityFramework.SqlServerCompact>`_
+  * Full .NET (4.5.1 onwards)
diff --git a/docs/providers/sql-server/index.rst b/docs/providers/sql-server/index.rst
@@ -1,41 +1,40 @@
 Microsoft SQL Server
 ====================
 
+This database provider allows Entity Framework Core to be used with Microsoft SQL Server (including SQL Azure). The provider is maintained as part of the `EntityFramework GitHub project <https://github.com/aspnet/EntityFramework>`_.
+
 .. contents:: `In this article:`
     :depth: 2
     :local:
 
-Getting Started
----------------
+Install
+-------
+
+Install the `Microsoft.EntityFrameworkCore.SqlServer NuGet package <hhttps://www.nuget.org/packages/Microsoft.EntityFrameworkCore.SqlServer/>`_.
+
+.. code-block:: text
+
+    PM>  Install-Package Microsoft.EntityFrameworkCore.SqlServer
+
+Get Started
+-----------
 
-The following tutorials use this provider:
+The following resources will help you get started with this provider.
   * :doc:`/platforms/full-dotnet/index`
   * :doc:`/platforms/aspnetcore/index`
-
-The following sample applications use this provider:
-  * `UnicornStore <https://github.com/rowanmiller/UnicornStore/tree/master/UnicornStore>`_
+  * `UnicornStore Sample Application <https://github.com/rowanmiller/UnicornStore/tree/master/UnicornStore>`_
 
 Supported Database Engines
 --------------------------
 
-Microsoft SQL Server (2008 onwards)
+  * Microsoft SQL Server (2008 onwards)
 
 Supported Platforms
 -------------------
 
- * Full .NET (4.5.1 onwards)
- * .NET Core
- * Mono (4.2.0 onwards)
-
-.. caution::
-    Using this provider on Mono will make use of the Mono SQL Client implementation, which has a number of known issues. For example, it does not support secure connections (SSL).
-
-Status
-------
-
-`Microsoft.EntityFrameworkCore.SqlServer package available on NuGet.org <https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.SqlServer>`_
-
-Project Site
-------------
+  * Full .NET (4.5.1 onwards)
+  * .NET Core
+  * Mono (4.2.0 onwards)
 
-`EntityFramework GitHub project <https://github.com/aspnet/EntityFramework>`_
+   .. caution::
+      Using this provider on Mono will make use of the Mono SQL Client implementation, which has a number of known issues. For example, it does not support secure connections (SSL).