diff --git a/getting-started/vs-integration/images/upgrade-wizard-backup.png b/getting-started/vs-integration/images/upgrade-wizard-backup.png new file mode 100644 index 0000000000..6a88a2c4e4 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-backup.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-information.png b/getting-started/vs-integration/images/upgrade-wizard-information.png new file mode 100644 index 0000000000..581edb1f39 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-information.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-localization-file-invalid.png b/getting-started/vs-integration/images/upgrade-wizard-localization-file-invalid.png new file mode 100644 index 0000000000..bfb19abd20 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-localization-file-invalid.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-localization-file.png b/getting-started/vs-integration/images/upgrade-wizard-localization-file.png new file mode 100644 index 0000000000..cfdbbc5713 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-localization-file.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-log.png b/getting-started/vs-integration/images/upgrade-wizard-log.png new file mode 100644 index 0000000000..1bc22b0d88 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-log.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-open.png b/getting-started/vs-integration/images/upgrade-wizard-open.png new file mode 100644 index 0000000000..56f42e0629 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-open.png differ diff --git a/getting-started/vs-integration/images/upgrade-wizard-projects.png b/getting-started/vs-integration/images/upgrade-wizard-projects.png new file mode 100644 index 0000000000..c778e06489 Binary files /dev/null and b/getting-started/vs-integration/images/upgrade-wizard-projects.png differ diff --git a/getting-started/vs-integration/troubleshooting.md b/getting-started/vs-integration/troubleshooting.md index b876f81250..91d2490982 100644 --- a/getting-started/vs-integration/troubleshooting.md +++ b/getting-started/vs-integration/troubleshooting.md @@ -3,7 +3,7 @@ title: Troubleshooting page_title: Troubleshooting - Visual Studio Integration description: Troubleshooting steps for Telerik UI for Blazor Visual Studio extensions. slug: getting-started-vs-integration-troubleshooting -position: 5 +position: 6 --- # Troubleshooting diff --git a/getting-started/vs-integration/upgrade-wizard.md b/getting-started/vs-integration/upgrade-wizard.md new file mode 100644 index 0000000000..142b42b81d --- /dev/null +++ b/getting-started/vs-integration/upgrade-wizard.md @@ -0,0 +1,87 @@ +--- +title: Upgrading Projects +page_title: Upgrade Project - Visual Studio Integration +description: Learn how to upgrade a Telerik UI for Blazor project with our Visual Studio Extension. +slug: getting-started-vs-integration-upgrade-project +position: 5 +--- + +# Upgrading Projects + +This article demonstrates how to use the [Telerik Visual Studio Extension]({% slug getting-started-vs-integration-overview %}) to upgrade a project that is pre-configured for the Progress® Telerik® UI for Blazor components. + +## Basics + +The **Upgrade Project Wizard** upgrades the version of existing Telerik UI for Blazor applications. To open the wizard, right-click on the **Project in the Solution Explorer -> Telerik UI for Blazor -> Upgrade Wizard**. + +![Open Upgrade Wizard](images/upgrade-wizard-open.png) + +## Files for Upgrade + +The **Upgrade Information** step of the Upgrade Project Wizard describes the files and assemblies that will be upgraded. + +![Upgrade Wizard Information Page](images/upgrade-wizard-information.png) + +The Telerik Blazor Upgrade Wizard will do the following: + +* Update the version of the referenced Blazor NuGet package. It will also update the package source in the solution-based NuGet config file. +* It will update the version of the theme references (If CDN is used, it will be also updated). +* It will update all local script and style and NuGet package references in case client upgrades from Trial to Dev version. +* It will add the new keys in the default (English) localization file. + +## Projects for Upgrade + +The next page of the Upgrade Wizard lists all projects from the solution that use Telerik UI for Blazor. Choose the projects that you want to upgrade and the version to which they will be upgraded. + +>tip We recommend selecting all projects that reference UI for Blazor and upgrading them to the same product version. + +![Upgrade Wizard Projects Selection](images/upgrade-wizard-projects.png) + +## Upgrade Localization File + +If localization is enabled in the application, you can select the **Upgrade the localization file** option. The Upgrade Wizard will add new localization keys from the default (English) localization file that UI for Blazor distributes. + +The option is selected by default if there is a **Resources\TelerikMessages.resx** file in the current project. In this case, **Resources\TelerikMessages.resx** file is selected in the file browser. + +![Upgrade Wizard Localization File](images/upgrade-wizard-localization-file.png) + +## Create Backup + +You can create a backup before running the upgrade wizard by selecting the **Create a backup before upgrading** option. + +>When the project and solution are placed in the same directory, the default backup location is set to the **%USERPROFILE%\Documents** folder. + +![Upgrade Wizard Backup](images/upgrade-wizard-backup.png) + + +## Upgrade Log + +In case one of the options ([Create a backup before upgrading](#create-backup) or [Upgrade the localization file](#upgrade-localization-file)) is selected, an **Upgrade Log** will be opened in your default browser at the end of the upgrade. The log can show the backup location, an entry for each localization key added or a localization upgrade error. Each upgrade log file is in HTML format. The file name contains the date and time of the upgrade. + +![Upgrade Wizard Log](images/upgrade-wizard-backup.png) + +## Troubleshooting + +The following common problems might occur when upgrading a project: + +* The [localization file is read-only or does not exists](#missing-localization-file). +* The [**Finish** button is disabled](#finish-button-is-disabled). + +### Missing Localization file + +If the selected localization file in the pointed directory is missing or read-only, the page state is not valid. In this case, the **Finish** button will display a tooltip when clicked, indicating a page error. + +![Upgrade Wizard Localization File](images/upgrade-wizard-localization-file-invalid.png) + +### Finish Button is Disabled + +If **Create a backup before upgrading** option is selected, and the **Backup location** is empty, the **Finish** button is disabled. + +## See Also + +* [Visual Studio Extensions Overview]({% slug getting-started-vs-integration-overview %}) +* [Downloading the Latest Telerik UI for Blazor Versions]({% slug getting-started-vs-integration-latest-version %}) +* [Getting Started with Client-Side Apps]({%slug getting-started/client-side%}) +* [Getting Started with Server-Side Apps]({%slug getting-started/server-side%}) +* [Workflow for Using the UI Components for Blazor]({%slug getting-started/what-you-need%}) + diff --git a/upgrade/overview.md b/upgrade/overview.md index 6bdea6f81c..150a4b2cae 100644 --- a/upgrade/overview.md +++ b/upgrade/overview.md @@ -25,6 +25,7 @@ The **latest** available version of UI for Blazor is **{{site.uiForBlazorLatestV In this article: * [Upgrade Process](#upgrade-process) +* [Upgrade with Upgrade Wizard](#upgrade-wizard) * [Upgrade from Trial to Commercial](#upgrade-from-trial-to-commercial) * [Troubleshooting](#troubleshooting) @@ -57,6 +58,10 @@ To upgrade the Telerik UI for Blazor components used in your project, perform th 1. If the application is localized, [update the Telerik localization (`.resx`) files]({%slug globalization-localization%}#how-localization-works-in-the-telerik-components). Otherwise you may see [exceptions related to missing localization strings]({%slug common-kb-null-value-parameter-format%}). +## Upgrade Wizard + +To upgrade the version of Telerik UI for Blazor you can use the [Upgrade Wizard]({%slug getting-started-vs-integration-upgrade-project%}) that comes as part of the [Telerik UI for Blazor Visual Studio Extension]({% slug getting-started-vs-integration-overview %}). + ## Upgrade from Trial to Commercial If you have just purchased a license and you need to migrate from the trial package to the licensed version, perform the following steps: