Skip to content

Commit 280b724

Browse files
committed
Updated UI Builder upgrade articles
1 parent 1681774 commit 280b724

File tree

3 files changed

+76
-56
lines changed

3 files changed

+76
-56
lines changed

15/umbraco-ui-builder/upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
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.
33
---
44

55
# Migrate from Konstrukt to Umbraco UI Builder
66

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.
88

9-
## Key changes
9+
## Key Changes
1010

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.
1412

1513
### Project, Package, and Namespace changes
1614

@@ -23,40 +21,44 @@ These changes will dictate the steps to take in the process of migrating to Umbr
2321
| Konstrukt.Startup | Umbraco.UIBuilder.Startup |
2422
| Konstrukt | Umbraco.UIBuilder |
2523

24+
### Code and UI Changes
25+
2626
<details>
2727

28-
<summary>C# Class changes</summary>
28+
<summary>C# Class Changes</summary>
2929

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.
32+
* Examples: `IKonstruktRepository` -> `IRepository`
33+
* Exceptions:
34+
* `KonstruktConfig` and `KonstruktConfigBuilder` now use a `UIBuilder` prefix.
35+
* `AddKonstrukt` extension for `IUmbracoBuilder` is now `AddUIBuilder`
3436

3537
</details>
3638

3739
<details>
3840

39-
<summary>JavaScript changes</summary>
41+
<summary>JavaScript Changes</summary>
4042

41-
* All `Konstrukt` controllers have changed namespace to `Umbraco.UIBuilder`.
42-
* All `Konstrukt` prefixed directives, services, and resources are now prefixed with `uibuilder`.
43+
* All `Konstrukt` controllers are now under the `Umbraco.UIBuilder` namespace.
44+
* All `Konstrukt` prefixed directives, services, and resources now use `uibuilder`.
4345

4446
</details>
4547

4648
<details>
4749

4850
<summary>UI Changes</summary>
4951

50-
* All static UI assets are served via a Razor Compiled Library (RCL) and are no longer found in the `App_Plugins` folder.
51-
* The folder with `App_Plugins` has been renamed from `Konstrukt` to `UmbracoUIBuilder`.
52+
* All static UI assets are now served via a Razor Compiled Library (RCL) instead of being stored in the `App_Plugins` folder.
53+
* The `App_Plugins/Konstrukt` folder is now `App_Plugins/UmbracoUIBuilder`.
5254

5355
</details>
5456

55-
## Step 1: Replace dependencies
57+
## Step 1: Replace Dependencies
5658

57-
In this first step, we will be replacing all existing Konstrukt dependencies with Umbraco UI Builder dependencies.
59+
Replace all existing Konstrukt dependencies with Umbraco UI Builder dependencies.
5860

59-
1. Remove any installed Konstrukt packages:
61+
1. Remove existing Konstrukt packages:
6062

6163
```bash
6264
dotnet remove package Konstrukt
@@ -76,14 +78,15 @@ dotnet add package Umbraco.UIBuilder
7678

7779
4. Compile your project against .NET 7.0.
7880

79-
## Step 2: Update namespaces and entity names
81+
## Step 2: Update Namespaces and Entity Names
8082

81-
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.
8284

83-
## Step 3: Update your configuration
85+
## Step 3: Update Configuration
8486

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`.
8688

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).
8790

8891
```csharp
8992
builder.CreateUmbracoBuilder()
@@ -97,12 +100,12 @@ builder.CreateUmbracoBuilder()
97100
.Build();
98101
```
99102

100-
## Step 4: Finalizing the migration
103+
## Step 4: Finalize the Migration
101104

102-
1. Delete any obj/bin folders in your projects to ensure a clean build.
103-
2. Recompile all projects and ensure all dependencies are restored correctly
104-
3. Delete the existing Konstrukt license files in the `umbraco\Licenses` folder.
105-
4. Add your new Umbraco.UIBuilder license key to the `appSettings.json` file:
105+
1. Delete `obj/bin` folders for a clean build.
106+
2. Recompile all projects and ensure all dependencies are restored correctly.
107+
3. Remove existing **Konstrukt** license files from `umbraco\Licenses` folder.
108+
4. Add your **Umbraco.UIBuilder** license key to the `appSettings.json` file:
106109

107110
```json
108111
"Umbraco": {
Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,65 @@
1+
---
2+
description: Learn how to manually upgrade Umbraco UI Builder to the latest version.
3+
---
4+
15
# Upgrading Umbraco UI Builder
26

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.
58

69
{% 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.
811
{% endhint %}
912

1013
## Get the latest version of Umbraco UI Builder
1114

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:
1316

14-
- NuGet
15-
- Visual Studio
17+
- [NuGet](#nuget)
18+
- [Visual Studio](#visual-studio)
1619

1720
### NuGet
1821

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:
2029

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.
30+
```sh
31+
dotnet add package Umbraco.UIBuilder --version <VERSION>
32+
```
33+
34+
- After adding the package reference, restore dependencies:
2235

36+
```sh
37+
dotnet restore
38+
```
2339

2440
### Visual Studio
2541

26-
1. Go to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...` in Visual Studio, to upgrade Umbraco UI Builder:
27-
2. Select **Umbraco.UIBuilder**.
28-
3. Select the latest version from the Version drop-down and click Install.
29-
4. When the command completes, open the **.csproj** file to make sure the package reference is updated:
42+
1. Open Visual Studio.
43+
2. Navigate to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution...`.
44+
3. Select **Umbraco.UIBuilder**.
45+
4. Choose the latest version from the drop-down and click **Install**.
46+
5. After installation, verify the update in your **.csproj** file:
3047

3148
```xml
3249
<ItemGroup>
3350
<PackageReference Include="Umbraco.UIBuilder" Version="xx.x.x" />
3451
</ItemGroup>
3552
```
3653

37-
If you are using one or more of the below sub-packages, they also need to be upgraded as well:
54+
## Upgrade Sub-Packages
55+
56+
If you are using any of the following sub-packages, upgrade them as well:
3857

3958
| Sub-package | Description |
4059
| -- | -- |
41-
| Umbraco.UIBuilder.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies |
42-
| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific project containing implementations of core UI Builder functionality |
43-
| Umbraco.UIBuilder.Web | The core UI Builder logic that requires a web context |
44-
| Umbraco.UIBuilder.Web.StaticAssets | The static assets for the UI Builder presentation layer |
45-
| Umbraco.UIBuilder.Startup | The main logic for registering UI Builder with Umbraco |
46-
| Umbraco.UIBuilder | The main UI Builder package |
60+
| Umbraco.UIBuilder.Core | Core functionality without infrastructure dependencies |
61+
| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific implementations |
62+
| Umbraco.UIBuilder.Web | Core logic requiring a web context |
63+
| Umbraco.UIBuilder.Web.StaticAssets |Static assets for the presentation layer |
64+
| Umbraco.UIBuilder.Startup | Registers UI Builder with Umbraco |
65+
| Umbraco.UIBuilder | The main UI Builder package |
Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
---
22
description: >-
3-
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.
44
---
55

66
# Version Specific Upgrade Notes
77

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.
99

1010
{% 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.
1212
{% endhint %}
1313

14-
## Version Specific Upgrade Notes History
14+
## Upgrade to Version 14
1515

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.
1717

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
1919

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).&#x20;
20+
For out-of-support versions, see the [Legacy documentation on GitHub](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).

0 commit comments

Comments
 (0)