diff --git a/13/umbraco-engage/SUMMARY.md b/13/umbraco-engage/SUMMARY.md index a34e6acd7d8..a721e04a6dc 100644 --- a/13/umbraco-engage/SUMMARY.md +++ b/13/umbraco-engage/SUMMARY.md @@ -1,6 +1,7 @@ # Table of contents * [Umbraco Engage Documentation](README.md) +* [Release Notes](release-notes.md) * [Support](support.md) ## Installation @@ -12,6 +13,8 @@ ## Upgrading +* [Upgrade Umbraco Engage](upgrading/upgrade-umbraco-engage.md) +* [Version specific Upgrade Notes](upgrading/version-specific-upgrade-notes.md) * [Migrate from uMarketingSuite](upgrading/migrate-from-umarketingsuite.md) ## Getting Started diff --git a/13/umbraco-engage/release-notes.md b/13/umbraco-engage/release-notes.md new file mode 100644 index 00000000000..bbe02c34f65 --- /dev/null +++ b/13/umbraco-engage/release-notes.md @@ -0,0 +1,15 @@ +--- +description: Get an overview of the changes and fixes in each version of Umbraco Engage. +--- + +# Release Notes + +In this section, you will find a summary of changes made to Umbraco Engage that were released in each version. Each version has a link to the [Engage issue tracker](https://github.com/umbraco/Umbraco.Engage.Issues/) showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail. + +If there are any breaking changes or other issues to be aware of when upgrading they are also noted here. + +{% hint style="info" %} +When upgrading to a major version, be sure to look at the breaking changes outlined in the [Version Specific Upgrade Notes](upgrading/version-specific-upgrade-notes.md) article. +{% endhint %} + +## Release History diff --git a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md new file mode 100644 index 00000000000..10b19c289a9 --- /dev/null +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -0,0 +1,49 @@ +# Upgrade Umbraco Engage + +This article shows how to upgrade Umbraco Engage to the latest version. + +When upgrading Umbraco Engage, you can consult the [version specific upgrade](version-specific-upgrade-notes.md) notes to learn about potential breaking changes and common pitfalls. + +{% hint style="warning" %} +Before you upgrade, it is recommended that your site and database be backed up. +{% endhint %} + +## Get the latest version of Umbraco Engage + +To upgrade to the latest version of Umbraco Engage you can use: + +* NuGet +* Visual Studio + +### NuGet + +1. Install the latest version using the `dotnet add package Umbraco.Engage` command. + * You can also specify version: `dotnet add package Umbraco.Engage --version `. +2. Run `dotnet restore` to install the package. + +### Visual Studio + +1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio. +2. Select **Umbraco.Engage**. +3. Select the latest version from the Version drop-down and click **Install**. + +When the task completes, open the **.csproj** file to make sure the package reference is updated: + +```xml + + + +``` + +If you are using one or more of the below sub-packages, they also need to be upgraded as well: + +| Sub-package | Description | +| -- | -- | +| Umbraco.Engage.Core | Core Engage functionality that doesn't require any infrastructure-specific dependencies. | +| Umbraco.Engage.Infrastructure | Infrastructure-specific project containing implementations of core Engage functionality. | +| Umbraco.Engage.Web | The core Engage logic that requires a web context. | +| Umbraco.Engage.Data | | +| Umbraco.Engage.Common | | +| Umbraco.Engage.Forms | A package that extends Umbraco Engage with Umbraco Forms. | +| Umbraco.Engage.Headless | A package that adds headless functionality to Umbraco Engage. | +| Umbraco.Engage.Commerce | A package that extends Umbraco Engage with Umbraco Commerce. | diff --git a/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md new file mode 100644 index 00000000000..ef1ef356c01 --- /dev/null +++ b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md @@ -0,0 +1,13 @@ +--- +description: Version specific documentation for upgrading to new major versions of Umbraco Engage. +--- + +# Version Specific Upgrade Notes + +This article provides specific upgrade instructions for migrating to major version of Umbraco Engage + +{% hint style="info" %} +When upgrading to a new minor or patch version, learn about the changes in the [Release Notes](../release-notes.md) article. +{% endhint %} + +## Breaking changes