-
Notifications
You must be signed in to change notification settings - Fork 811
Engage: Add more articles related to Upgrades #6774
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0854298
Add new files to structure
sofietoft 434e901
Update SUMMARY
sofietoft 55c3f05
Add content to new articles
sofietoft ee334fd
Update left over UI Builder reference
sofietoft e338419
Apply suggestions from code review
sofietoft 663ceba
Small fixes
sofietoft File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
eshanrnh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 1. Install the latest version using the `dotnet add package Umbraco.Engage` command. | ||
| * You can also specify version: `dotnet add package Umbraco.Engage --version <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 | ||
| <ItemGroup> | ||
| <PackageReference Include="Umbraco.Engage" Version="xx.x.x" /> | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
| 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 | | | ||
eshanrnh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | Umbraco.Engage.Common | | | ||
eshanrnh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | 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. | | ||
13 changes: 13 additions & 0 deletions
13
13/umbraco-engage/upgrading/version-specific-upgrade-notes.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.