From 085429831834e8b21d49292cb78c8059f77cb481 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Wed, 8 Jan 2025 12:31:45 +0100 Subject: [PATCH 1/6] Add new files to structure --- 13/umbraco-engage/SUMMARY.md | 2 ++ 13/umbraco-engage/release-notes.md | 1 + 13/umbraco-engage/upgrading/upgrade-umbraco-engage.md | 1 + 13/umbraco-engage/upgrading/version-specific-upgrade-notes.md | 1 + 4 files changed, 5 insertions(+) create mode 100644 13/umbraco-engage/release-notes.md create mode 100644 13/umbraco-engage/upgrading/upgrade-umbraco-engage.md create mode 100644 13/umbraco-engage/upgrading/version-specific-upgrade-notes.md diff --git a/13/umbraco-engage/SUMMARY.md b/13/umbraco-engage/SUMMARY.md index a34e6acd7d8..6b421e55688 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,7 @@ ## Upgrading +* [Upgrade Umbraco Engage](upgrading/upgrade-umbraco-engage.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..d7de275fc3f --- /dev/null +++ b/13/umbraco-engage/release-notes.md @@ -0,0 +1 @@ +# Release notes 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..5ca172d9735 --- /dev/null +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -0,0 +1 @@ +# Upgrade Umbraco Engage 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..3b45470ea08 --- /dev/null +++ b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md @@ -0,0 +1 @@ +# Version Specific Upgrade Notes From 434e9015222f1be32560534ad3cce039d0865e23 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Wed, 8 Jan 2025 12:32:17 +0100 Subject: [PATCH 2/6] Update SUMMARY --- 13/umbraco-engage/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/13/umbraco-engage/SUMMARY.md b/13/umbraco-engage/SUMMARY.md index 6b421e55688..892a2cf155d 100644 --- a/13/umbraco-engage/SUMMARY.md +++ b/13/umbraco-engage/SUMMARY.md @@ -14,6 +14,7 @@ ## 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 From 55c3f05967dffcaaab052a9ee6abbf860f72c939 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Wed, 8 Jan 2025 12:48:28 +0100 Subject: [PATCH 3/6] Add content to new articles --- 13/umbraco-engage/release-notes.md | 16 ++++++- .../upgrading/upgrade-umbraco-engage.md | 48 +++++++++++++++++++ .../version-specific-upgrade-notes.md | 12 +++++ 3 files changed, 75 insertions(+), 1 deletion(-) diff --git a/13/umbraco-engage/release-notes.md b/13/umbraco-engage/release-notes.md index d7de275fc3f..39ae5f4d8a7 100644 --- a/13/umbraco-engage/release-notes.md +++ b/13/umbraco-engage/release-notes.md @@ -1 +1,15 @@ -# Release notes +--- +description: Get an overview of the changes and fixes in each version of Umbraco Engage. +--- + +# Release Notes + +In this section, you can find a summary of changes to Umbraco Forms released in each version. Each version is presented with 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, learn about the breaking changes 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 index 5ca172d9735..642b10ec6d4 100644 --- a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -1 +1,49 @@ # Upgrade Umbraco Engage + +This article shows how to upgrade Umbraco Engage to the latest version. + +When upgrading Umbraco Engage, be sure to consult the [version specific upgrade](version-specific-upgrade-notes.md) notes to learn about potential breaking changes and common pitfalls. + +{% hint style="warning" %} +Before upgrading, it is recommended to backup your site and database. +{% 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.UIBuilder --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, to upgrade Umbraco Engage. +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 UI Builder 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 extend Umbraco Engage with Umbraco Forms. | +| Umbraco.Engage.Headless | A package that adds headless functionality to Umbraco Engage. | +| Umbraco.Engage.Commerce | A package that extend 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 index 3b45470ea08..c7616c7c9b1 100644 --- a/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md +++ b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md @@ -1 +1,13 @@ +--- +description: Version specific documentation for upgrading to new major versions of Umbraco Engage. +--- + # Version Specific Upgrade Notes + +This page covers specific upgrade documentation for when migrating to major xx 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 From ee334fdd3bec1c59fd56483062c16631e5a6b728 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Wed, 8 Jan 2025 12:53:44 +0100 Subject: [PATCH 4/6] Update left over UI Builder reference --- 13/umbraco-engage/upgrading/upgrade-umbraco-engage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md index 642b10ec6d4..7a53497c152 100644 --- a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -18,7 +18,7 @@ To upgrade to the latest version of Umbraco Engage you can use: ### NuGet 1. Install the latest version using the `dotnet add package Umbraco.Engage` command. - * You can also specify version: `dotnet add package Umbraco.UIBuilder --version `. + * You can also specify version: `dotnet add package Umbraco.Engage --version `. 2. Run `dotnet restore` to install the package. ### Visual Studio From e3384199a50773b54ced2dea714b1e6dc47e9f8b Mon Sep 17 00:00:00 2001 From: sofietoft Date: Fri, 10 Jan 2025 08:55:50 +0100 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> --- 13/umbraco-engage/SUMMARY.md | 2 +- 13/umbraco-engage/release-notes.md | 4 ++-- 13/umbraco-engage/upgrading/upgrade-umbraco-engage.md | 2 +- 13/umbraco-engage/upgrading/version-specific-upgrade-notes.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/13/umbraco-engage/SUMMARY.md b/13/umbraco-engage/SUMMARY.md index 892a2cf155d..a721e04a6dc 100644 --- a/13/umbraco-engage/SUMMARY.md +++ b/13/umbraco-engage/SUMMARY.md @@ -1,7 +1,7 @@ # Table of contents * [Umbraco Engage Documentation](README.md) -* [Release notes](release-notes.md) +* [Release Notes](release-notes.md) * [Support](support.md) ## Installation diff --git a/13/umbraco-engage/release-notes.md b/13/umbraco-engage/release-notes.md index 39ae5f4d8a7..bbe02c34f65 100644 --- a/13/umbraco-engage/release-notes.md +++ b/13/umbraco-engage/release-notes.md @@ -4,12 +4,12 @@ description: Get an overview of the changes and fixes in each version of Umbraco # Release Notes -In this section, you can find a summary of changes to Umbraco Forms released in each version. Each version is presented with 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. +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, learn about the breaking changes in the [Version Specific Upgrade Notes](upgrading/version-specific-upgrade-notes.md) article. +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 index 7a53497c152..504acc8a2d3 100644 --- a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -23,7 +23,7 @@ To upgrade to the latest version of Umbraco Engage you can use: ### Visual Studio -1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio, to upgrade Umbraco Engage. +1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio to upgrade Umbraco Engage. 2. Select **Umbraco.Engage**. 3. Select the latest version from the Version drop-down and click **Install**. diff --git a/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md index c7616c7c9b1..ef1ef356c01 100644 --- a/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md +++ b/13/umbraco-engage/upgrading/version-specific-upgrade-notes.md @@ -4,7 +4,7 @@ description: Version specific documentation for upgrading to new major versions # Version Specific Upgrade Notes -This page covers specific upgrade documentation for when migrating to major xx of Umbraco Engage. +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. From 663ceba841a9b4a9ab04913083ef3f91b39498fa Mon Sep 17 00:00:00 2001 From: sofietoft Date: Tue, 14 Jan 2025 08:51:05 +0100 Subject: [PATCH 6/6] Small fixes --- .../upgrading/upgrade-umbraco-engage.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md index 504acc8a2d3..10b19c289a9 100644 --- a/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md +++ b/13/umbraco-engage/upgrading/upgrade-umbraco-engage.md @@ -2,10 +2,10 @@ This article shows how to upgrade Umbraco Engage to the latest version. -When upgrading Umbraco Engage, be sure to consult the [version specific upgrade](version-specific-upgrade-notes.md) notes to learn about potential breaking changes and common pitfalls. +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 upgrading, it is recommended to backup your site and database. +Before you upgrade, it is recommended that your site and database be backed up. {% endhint %} ## Get the latest version of Umbraco Engage @@ -23,7 +23,7 @@ To upgrade to the latest version of Umbraco Engage you can use: ### Visual Studio -1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio to upgrade Umbraco Engage. +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**. @@ -39,11 +39,11 @@ If you are using one or more of the below sub-packages, they also need to be upg | Sub-package | Description | | -- | -- | -| Umbraco.Engage.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies. | +| 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 extend Umbraco Engage with Umbraco Forms. | +| 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 extend Umbraco Engage with Umbraco Commerce. | +| Umbraco.Engage.Commerce | A package that extends Umbraco Engage with Umbraco Commerce. |