You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 15/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md
+31-28Lines changed: 31 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,14 @@
1
1
---
2
-
description: Learn how to migrate a Konstrukt solution to Umbraco UI Builder.
2
+
description: Step-by-step guide to migrating a Konstrukt solution to Umbraco UI Builder.
3
3
---
4
4
5
5
# Migrate from Konstrukt to Umbraco UI Builder
6
6
7
-
This guide provides a step-by-step approach to migrating a default Konstrukt solution to Umbraco UI Builder.
7
+
This guide walks you through migrating a default Konstrukt solution to Umbraco UI Builder.
8
8
9
-
## Key changes
9
+
## Key Changes
10
10
11
-
Before outlining the exact steps, there are a few key changes to be aware of.
12
-
13
-
These changes will dictate the steps to take in the process of migrating to Umbraco UI Builder.
11
+
Before starting, review these key changes that impact the migration process.
14
12
15
13
### Project, Package, and Namespace changes
16
14
@@ -23,40 +21,44 @@ These changes will dictate the steps to take in the process of migrating to Umbr
23
21
| Konstrukt.Startup | Umbraco.UIBuilder.Startup |
24
22
| Konstrukt | Umbraco.UIBuilder |
25
23
24
+
### Code and UI Changes
25
+
26
26
<details>
27
27
28
-
<summary>C# Class changes</summary>
28
+
<summary>C# Class Changes</summary>
29
29
30
-
* Namespace changes as documented above.
31
-
* Most classes prefixed with the `Konstrukt` keyword have had this prefix removed.
32
-
* Examples: `IKonstruktRepository` is now `IRepository`
33
-
* Exclusions: The root level `KonstruktConfig` and `KonstruktConfigBuilder` have a `UIBuilder` prefix instead, and the `AddKonstrukt` extension for `IUmbracoBuilder` has been replaced by `AddUIBuilder`
30
+
* Namespace changes as mentioned above.
31
+
* Most `Konstrukt`-prefixed classes have had the prefix removed.
Based on the [Key Changes](./#key-changes) outlined above update all Konstrukt references to the new Umbraco UI Builder alternatives. Ensure you update any Views/Partials that also reference these.
83
+
Update all Konstrukt references to their Umbraco UI Builder alternatives. Ensure you update any Views/Partials that also reference these. See the [Key Changes](./#key-changes) section for reference.
82
84
83
-
## Step 3: Update your configuration
85
+
## Step 3: Update Configuration
84
86
85
-
If all your configuration is in a single statement, it would be a case of swapping `AddKonstrukt`to`AddUIBuilder`. If you broke your configuration into multiple steps, or are using `Action` or `Card` classes, you will need to update the config builder/base classes. Those classes need to be updated to their UI Builder alternative names as detailed in [Key Changes](./#key-changes).
87
+
If your configuration is in a single statement, replace `AddKonstrukt`with`AddUIBuilder`.
86
88
89
+
For multi-step configurations using `Action` or `Card` classes, update the **config builders** and **base classes** to their UI Builder alternatives as described in [Key Changes](./#key-changes).
description: Learn how to manually upgrade Umbraco UI Builder to the latest version.
3
+
---
4
+
1
5
# Upgrading Umbraco UI Builder
2
6
3
-
This article shows how to manually upgrade Umbraco UI Builder to run the latest version.
4
-
When upgrading Umbraco UI Builder, be sure to also consult the [version specific upgrade](version-specific.md) notes to learn about potential breaking changes and common pitfalls.
7
+
This article explains how to manually upgrade Umbraco UI Builder to the latest version. Before upgrading Umbraco UI Builder, see the [Version Specific Upgrade Notes](version-specific.md) for potential breaking changes and common pitfalls.
5
8
6
9
{% hint style="warning" %}
7
-
Before upgrading, it is always advisable to take a complete backup of your site and database.
10
+
Before upgrading, take a complete backup of your site and database.
8
11
{% endhint %}
9
12
10
13
## Get the latest version of Umbraco UI Builder
11
14
12
-
To upgrade to the latest version of Umbraco UI Builder you can use:
15
+
To get the latest version of Umbraco UI Builder, you can upgrade using either of the two options:
13
16
14
-
- NuGet
15
-
- Visual Studio
17
+
-[NuGet](#nuget)
18
+
-[Visual Studio](#visual-studio)
16
19
17
20
### NuGet
18
21
19
-
- NuGet installs the latest version of the package when you use the `dotnet add package Umbraco.UIBuilder` command unless you specify a package version: `dotnet add package Umbraco.UIBuilder --version <VERSION>`
22
+
- To install the latest version via NuGet:
23
+
24
+
```sh
25
+
dotnet add package Umbraco.UIBuilder
26
+
```
27
+
28
+
- To specify a package version:
20
29
21
-
- After you have added a package reference to your project by executing the `dotnet add package Umbraco.UIBuilder` command in the directory that contains your project file, run `dotnet restore` to install the package.
Version specific documentation for upgrading to new major versions of Umbraco UI Builder.
3
+
Version specific documentation for upgrading to major versions of Umbraco UI Builder.
4
4
---
5
5
6
6
# Version Specific Upgrade Notes
7
7
8
-
This page covers specific upgrade documentation for when migrating to major 14 of Umbraco UI Builder.
8
+
This article provides upgrade instructions for major versions of Umbraco UI Builder.
9
9
10
10
{% hint style="info" %}
11
-
If you are upgrading to a new minor or patch version, you can find information about the breaking changes in the [Release Notes](../release-notes.md)article.
11
+
For minor or patch upgrades, check the [Release Notes](../release-notes.md)for breaking changes.
12
12
{% endhint %}
13
13
14
-
## Version Specific Upgrade Notes History
14
+
## Upgrade to Version 14
15
15
16
-
Version 14 contains a number of breaking changes from the previous, Konstrukt product.
16
+
Version 14 introduces breaking changes from the previous Konstrukt product. For full migration details, see the [Migrate from Konstrukt to Umbraco UI Builder](./migrating-from-konstrukt-to-umbraco-ui-builder.md) article.
17
17
18
-
See the [Migrate from Konstrukt to Umbraco UI Builder guide](./migrating-from-konstrukt-to-umbraco-ui-builder.md) for full details.
18
+
## Legacy Version Upgrade Notes
19
19
20
-
## Legacy version specific upgrade notes
21
-
22
-
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on GitHub](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions). 
20
+
For out-of-support versions, see the [Legacy documentation on GitHub](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).
0 commit comments