Move version history to the docs website.

bgrainger · bgrainger · commit 38f2bb80eea7 · 2017-03-27T12:01:41.000-07:00
Change &lt;PackageReleaseNotes&gt; to just link to the online documentation (instead of needing to be updated with every release).
diff --git a/docs/VersionHistory.md b/docs/VersionHistory.md
@@ -2,151 +2,8 @@
 
 ## Known Issues
 
-* The behaviour of cancellation is not well-defined in this release; cancelling a query
-may leave the `MySqlConnection` in an unusable state.
-* Not all MySQL data types are supported.
-* Many `MySql.Data` connection string settings are not supported by this library. See
-[Connection Options](https://mysql-net.github.io/MySqlConnector/connection-options/) for a list
-of supported options.
-* Only the "`mysql_native_password`" and "`mysql_old_password`" authentication plugins are supported.
+Known Issues have [moved here](https://mysql-net.github.io/MySqlConnector/overview/known-issues/).
 
 ## Release Notes
 
-### 0.15.2
-
-* Include help on `AllowUserVariables` in exception message: [#206](https://github.com/mysql-net/MySqlConnector/issues/206).
-
-### 0.15.1
-
-* Fix `NullReferenceException` in `MySqlConnection.Database`: [#205](https://github.com/mysql-net/MySqlConnector/issues/205).
-
-### 0.15.0
-
-* Implement `MySqlConnection.ChangeDatabase`: [#201](https://github.com/mysql-net/MySqlConnector/issues/201).
-* Add `Buffer Result Sets` connection string option: [#202](https://github.com/mysql-net/MySqlConnector/issues/202).
-
-### 0.14.1
-
-* Fix exception when `MySqlDataReader` isn't disposed: [#196](https://github.com/mysql-net/MySqlConnector/issues/196).
-
-### 0.14.0
-
-* Update `System.*` package references: [#190](https://github.com/mysql-net/MySqlConnector/issues/190).
-
-### 0.13.0
-
-* Add `MySqlBulkLoader`: [#15](https://github.com/mysql-net/MySqlConnector/issues/15).
-
-### 0.12.0
-
-* Add support for `DateTimeOffset`: [#172](https://github.com/mysql-net/MySqlConnector/issues/172), [#175](https://github.com/mysql-net/MySqlConnector/issues/175).
-
-### 0.11.6
-
-* Fix `PlatformNotSupportedException` on AWS Lambda: [#170](https://github.com/mysql-net/MySqlConnector/issues/170).
-
-### 0.11.5
-
-* Further improve async and sync performance: [#164](https://github.com/mysql-net/MySqlConnector/issues/164).
-
-### 0.11.4
-
-* No changes in this release.
-
-### 0.11.3
-
-* Improve async performance: [#164](https://github.com/mysql-net/MySqlConnector/issues/164).
-
-### 0.11.2
-
-* Fix InvalidCastException when using aggregate functions: [#54](https://github.com/mysql-net/MySqlConnector/issues/54).
-
-### 0.11.1
-
-* Handle `IOException` in `MySqlSession.DisposeAsync`: [#159](https://github.com/mysql-net/MySqlConnector/issues/159).
-
-### 0.11.0
-
-* Implement the `SslMode=Preferred` connection string option and make it the default: [#158](https://github.com/mysql-net/MySqlConnector/pull/158).
-
-### 0.10.0
-
-* Change minimum supported .NET Framework version to .NET 4.5.1: [#154](https://github.com/mysql-net/MySqlConnector/issues/154).
-
-### 0.9.2
-
-* Fix MySqlConnection.DataSource with Unix Domain Socket: [#152](https://github.com/mysql-net/MySqlConnector/issues/152).
-
-### 0.9.1
-
-* Fix `SocketException` when calling `OpenAsync`: [#150](https://github.com/mysql-net/MySqlConnector/issues/150).
-
-### 0.9.0
-
-* Implement `Treat Tiny As Boolean` connection string option: [#141](https://github.com/mysql-net/MySqlConnector/issues/141).
-
-### 0.8.0
-
-* Implement `Keep Alive` connection string option: [#132](https://github.com/mysql-net/MySqlConnector/issues/132).
-
-### 0.7.4
-
-* Fix `Packet received out-of-order` exception with `UseCompression=true`: [#146](https://github.com/mysql-net/MySqlConnector/issues/146).
-
-### 0.7.3
-
-* Fix `GetDataTypeName` for `ENUM` and `SET` columns: [#52](https://github.com/mysql-net/MySqlConnector/issues/52), [#71](https://github.com/mysql-net/MySqlConnector/issues/71).
-
-### 0.7.2
-
-* Fix authentication for MySQL Server 5.1: [#139](https://github.com/mysql-net/MySqlConnector/issues/139).
-
-### 0.7.1
-
-* Fix `NextResult` incorrectly returning `true`, which may cause problems with Dapper's `QueryMultiple`: [#135](https://github.com/mysql-net/MySqlConnector/issues/135).
-* Reduce memory usage related to `Enum.HasFlag`: [#137](https://github.com/mysql-net/MySqlConnector/issues/137).
-
-### 0.7.0
-
-* Implement stored procedure support: [#19](https://github.com/mysql-net/MySqlConnector/issues/19).
- * Known issue: `NextResult` incorrectly returns `true`, which may cause problems with Dapper's `QueryMultiple`: [#135](https://github.com/mysql-net/MySqlConnector/issues/135).
-
-### 0.6.2
-
-* Fix `NullReferenceException` when `MySqlParameter.Value == null`: [#126](https://github.com/mysql-net/MySqlConnector/issues/126).
-
-### 0.6.1
-
-* Fix `AggregateException` going unhandled in `OpenAsync`: [#124](https://github.com/mysql-net/MySqlConnector/issues/124).
-* Fix SSL over Unix domain sockets.
-* Reduce allocations when using SSL certificates.
-
-### 0.6.0
-
-* Implement `UseCompression` connection string option: [#31](https://github.com/mysql-net/MySqlConnector/issues/31).
-* Add support for Unix domain sockets: [#118](https://github.com/mysql-net/MySqlConnector/issues/118).
-
-### 0.5.0
-
-* Implement `UseAffectedRows` connection string option. (Note that the default value is `true`, unlike `MySql.Data`.)
-
-### 0.4.0
-
-* Rename `SslMode` enum to `MySqlSslMode` (for compatibility with `MySql.Data`):[#102](https://github.com/mysql-net/MySqlConnector/pull/93).
-
-### 0.3.0
-
-* Add SSL support and `SslMode` connection string option: [#88](https://github.com/mysql-net/MySqlConnector/issues/88).
-* Rewrite protocol serialization layer to support SSL and make adding compression easier: [#93](https://github.com/mysql-net/MySqlConnector/pull/93).
-
-### 0.2.1
-
-* Add more diagnostics for unsupported auth plugins.
-
-### 0.2.0
-
-* Add `MySqlConnectionStringBuilder.ForceSynchronous`: [#91](https://github.com/mysql-net/MySqlConnector/issues/91).
-
-### 0.1.0
-
-* First non-alpha release. Supports core data access scenarios with common ORMs.
+Release Notes have [moved here](https://mysql-net.github.io/MySqlConnector/overview/version-history/).
diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md
@@ -5,7 +5,7 @@ menu:
   main:
     parent: getting started
 title: Configuration
-weight: 20
+weight: 40
 ---
 
 Configuration
@@ -64,4 +64,4 @@ public void SyncMethod()
     // db.Connection was closed by AppDb.Dispose
 }
 
-```
+```
diff --git a/docs/content/overview/known-issues.md b/docs/content/overview/known-issues.md
@@ -0,0 +1,19 @@
+---
+lastmod: 2017-03-27
+date: 2017-03-27
+menu:
+  main:
+    parent: getting started
+title: Known Issues
+weight: 20
+---
+
+Known Issues
+============
+
+* The behaviour of cancellation is not well-defined in this release; cancelling a query
+may leave the `MySqlConnection` in an unusable state.
+* Not all MySQL data types are supported.
+* Many `MySql.Data` connection string settings are not supported by this library. See
+[Connection Options](connection-options/) for a list of supported options.
+* Only the `mysql_native_password` and `mysql_old_password` authentication plugins are supported.
diff --git a/docs/content/overview/use-with-orms.md b/docs/content/overview/use-with-orms.md
@@ -5,7 +5,7 @@ menu:
   main:
     parent: getting started
 title: Use with ORMs
-weight: 30
+weight: 50
 ---
 
 Use with ORMs
diff --git a/docs/content/overview/version-history.md b/docs/content/overview/version-history.md
@@ -0,0 +1,151 @@
+---
+lastmod: 2017-03-27
+date: 2017-03-27
+menu:
+  main:
+    parent: getting started
+title: Version History
+weight: 30
+---
+
+Version History
+===============
+
+### 0.15.2
+
+* Include help on `AllowUserVariables` in exception message: [#206](https://github.com/mysql-net/MySqlConnector/issues/206).
+
+### 0.15.1
+
+* Fix `NullReferenceException` in `MySqlConnection.Database`: [#205](https://github.com/mysql-net/MySqlConnector/issues/205).
+
+### 0.15.0
+
+* Implement `MySqlConnection.ChangeDatabase`: [#201](https://github.com/mysql-net/MySqlConnector/issues/201).
+* Add `Buffer Result Sets` connection string option: [#202](https://github.com/mysql-net/MySqlConnector/issues/202).
+
+### 0.14.1
+
+* Fix exception when `MySqlDataReader` isn't disposed: [#196](https://github.com/mysql-net/MySqlConnector/issues/196).
+
+### 0.14.0
+
+* Update `System.*` package references: [#190](https://github.com/mysql-net/MySqlConnector/issues/190).
+
+### 0.13.0
+
+* Add `MySqlBulkLoader`: [#15](https://github.com/mysql-net/MySqlConnector/issues/15).
+
+### 0.12.0
+
+* Add support for `DateTimeOffset`: [#172](https://github.com/mysql-net/MySqlConnector/issues/172), [#175](https://github.com/mysql-net/MySqlConnector/issues/175).
+
+### 0.11.6
+
+* Fix `PlatformNotSupportedException` on AWS Lambda: [#170](https://github.com/mysql-net/MySqlConnector/issues/170).
+
+### 0.11.5
+
+* Further improve async and sync performance: [#164](https://github.com/mysql-net/MySqlConnector/issues/164).
+
+### 0.11.4
+
+* No changes in this release.
+
+### 0.11.3
+
+* Improve async performance: [#164](https://github.com/mysql-net/MySqlConnector/issues/164).
+
+### 0.11.2
+
+* Fix InvalidCastException when using aggregate functions: [#54](https://github.com/mysql-net/MySqlConnector/issues/54).
+
+### 0.11.1
+
+* Handle `IOException` in `MySqlSession.DisposeAsync`: [#159](https://github.com/mysql-net/MySqlConnector/issues/159).
+
+### 0.11.0
+
+* Implement the `SslMode=Preferred` connection string option and make it the default: [#158](https://github.com/mysql-net/MySqlConnector/pull/158).
+
+### 0.10.0
+
+* Change minimum supported .NET Framework version to .NET 4.5.1: [#154](https://github.com/mysql-net/MySqlConnector/issues/154).
+
+### 0.9.2
+
+* Fix MySqlConnection.DataSource with Unix Domain Socket: [#152](https://github.com/mysql-net/MySqlConnector/issues/152).
+
+### 0.9.1
+
+* Fix `SocketException` when calling `OpenAsync`: [#150](https://github.com/mysql-net/MySqlConnector/issues/150).
+
+### 0.9.0
+
+* Implement `Treat Tiny As Boolean` connection string option: [#141](https://github.com/mysql-net/MySqlConnector/issues/141).
+
+### 0.8.0
+
+* Implement `Keep Alive` connection string option: [#132](https://github.com/mysql-net/MySqlConnector/issues/132).
+
+### 0.7.4
+
+* Fix `Packet received out-of-order` exception with `UseCompression=true`: [#146](https://github.com/mysql-net/MySqlConnector/issues/146).
+
+### 0.7.3
+
+* Fix `GetDataTypeName` for `ENUM` and `SET` columns: [#52](https://github.com/mysql-net/MySqlConnector/issues/52), [#71](https://github.com/mysql-net/MySqlConnector/issues/71).
+
+### 0.7.2
+
+* Fix authentication for MySQL Server 5.1: [#139](https://github.com/mysql-net/MySqlConnector/issues/139).
+
+### 0.7.1
+
+* Fix `NextResult` incorrectly returning `true`, which may cause problems with Dapper's `QueryMultiple`: [#135](https://github.com/mysql-net/MySqlConnector/issues/135).
+* Reduce memory usage related to `Enum.HasFlag`: [#137](https://github.com/mysql-net/MySqlConnector/issues/137).
+
+### 0.7.0
+
+* Implement stored procedure support: [#19](https://github.com/mysql-net/MySqlConnector/issues/19).
+ * Known issue: `NextResult` incorrectly returns `true`, which may cause problems with Dapper's `QueryMultiple`: [#135](https://github.com/mysql-net/MySqlConnector/issues/135).
+
+### 0.6.2
+
+* Fix `NullReferenceException` when `MySqlParameter.Value == null`: [#126](https://github.com/mysql-net/MySqlConnector/issues/126).
+
+### 0.6.1
+
+* Fix `AggregateException` going unhandled in `OpenAsync`: [#124](https://github.com/mysql-net/MySqlConnector/issues/124).
+* Fix SSL over Unix domain sockets.
+* Reduce allocations when using SSL certificates.
+
+### 0.6.0
+
+* Implement `UseCompression` connection string option: [#31](https://github.com/mysql-net/MySqlConnector/issues/31).
+* Add support for Unix domain sockets: [#118](https://github.com/mysql-net/MySqlConnector/issues/118).
+
+### 0.5.0
+
+* Implement `UseAffectedRows` connection string option. (Note that the default value is `true`, unlike `MySql.Data`.)
+
+### 0.4.0
+
+* Rename `SslMode` enum to `MySqlSslMode` (for compatibility with `MySql.Data`):[#102](https://github.com/mysql-net/MySqlConnector/pull/93).
+
+### 0.3.0
+
+* Add SSL support and `SslMode` connection string option: [#88](https://github.com/mysql-net/MySqlConnector/issues/88).
+* Rewrite protocol serialization layer to support SSL and make adding compression easier: [#93](https://github.com/mysql-net/MySqlConnector/pull/93).
+
+### 0.2.1
+
+* Add more diagnostics for unsupported auth plugins.
+
+### 0.2.0
+
+* Add `MySqlConnectionStringBuilder.ForceSynchronous`: [#91](https://github.com/mysql-net/MySqlConnector/issues/91).
+
+### 0.1.0
+
+* First non-alpha release. Supports core data access scenarios with common ORMs.
diff --git a/src/MySqlConnector/MySqlConnector.csproj b/src/MySqlConnector/MySqlConnector.csproj
@@ -11,7 +11,7 @@
     <AssemblyName>MySqlConnector</AssemblyName>
     <PackageId>MySqlConnector</PackageId>
     <PackageTags>mysql;async;ado.net;database;netcore</PackageTags>
-    <PackageReleaseNotes>Include help on AllowUserVariables in exception message: GitHub issue #206.</PackageReleaseNotes>
+    <PackageReleaseNotes>https://mysql-net.github.io/MySqlConnector/overview/version-history/</PackageReleaseNotes>
     <PackageProjectUrl>https://github.com/mysql-net/MySqlConnector</PackageProjectUrl>
     <PackageLicenseUrl>https://opensource.org/licenses/MIT</PackageLicenseUrl>
     <RepositoryType>git</RepositoryType>
