Skip to content

Commit 0d03e38

Browse files
docs(vsx): troubleshooting for upgrade wizard
1 parent 515970e commit 0d03e38

File tree

5 files changed

+55
-4
lines changed

5 files changed

+55
-4
lines changed

_contentTemplates/common/general-info.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,14 @@ You can reference the built-in Telerik assets from a cloud CDN instead of a loca
6060
6161
>note We are considering a better CDN option for the themes. Until then, you can use the unpkg workaround above, or local dependency management as described below.
6262
63+
#end
64+
65+
66+
67+
#vsx-download
68+
You can get them from the:
69+
70+
* [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=TelerikInc.TelerikBlazorVSExtensions)
71+
* [Telerik UI for Blazor automated installer]({%slug installation/msi%})
72+
6373
#end

getting-started/vs-integration/convert-project-wizard.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ This article demonstrates how to enable the Progress® Telerik® UI for Bl
1212

1313
To add the Telerik Components to you existing Blazor application, use the use the **Convert Project Wizard**. The wizard detects all installed versions of Telerik UI for Blazor and lists them in the **Version** combobox—this enables you to start your project with the desired version. You can also [get the latest version]({%slug getting-started-vs-integration-latest-version%}) to make sure you are up to date.
1414

15+
## Get the Wizard
16+
17+
To use the **Convert Project Wizard**, install the Telerik UI for Blazor Visual Studio Extensions. @[template](/_contentTemplates/common/general-info.md#vsx-download)
18+
19+
20+
21+
## Start the Wizard
22+
1523
To start the wizard, do the following:
1624

1725
1. In the **Solution Explorer**, select the Blazor app you want to add the Telerik components to (either WebAssembly, or Server-side Blazor)
@@ -40,6 +48,35 @@ To get a better understanding of what the wizard does for you, see either of the
4048
* [Getting Started with Server-side apps]({%slug getting-started/server-side%})
4149
* [Overview of what you need]({%slug getting-started/what-you-need%})
4250

51+
## Troubleshooting
52+
53+
There are two common problems when converting a project:
54+
55+
* The convertion wizard fails with an [error screen](#error-screen)
56+
* The [Telerik components do not work](#components-fail) after you run the converted project
57+
58+
### Error Screen
59+
60+
If you see an error screen similar to the one below, make sure that the actual Blazor application is selected in the Solution Explorer. This is most common with WebAssemly types of applications as they consist of a Server and Shared projects by default, and only the Client project is the actual Blazor app that needs the Telerik components.
61+
62+
In case the automation fails for other reasons and you see an exception dialog message from the Telerik extensions, it is likely that something a bit peculiar is happening with the particular project and you would have to perform the steps by hand. There are only three, and you can find them in the [What You Need]({%slug getting-started/what-you-need%}) article.
63+
64+
>caption Error screen when the project can't be converted
65+
66+
![The Convert Project Failed](images/convert-project-wizard-failed.png)
67+
68+
69+
### Components Fail
70+
71+
The issue can manifest in a couple of ways:
72+
73+
* The components have no styling
74+
* There are JavaScript errors that Telerik objects cannot be found
75+
76+
The most common reason for this problem is a mismatch between the installed version and the actual license that you have. For example, the wizard did not properly detect it, or there is only a Trial version installed, but already have a license, but simply never installed the new version.
77+
78+
At its root, the problem stems from wrong paths to the needed web assets and you can easily fix it by opening your index file (`wwwroot/index.html` for a WebAssembly app, and `Pages/_Host.cshtml` for a server-side Blazor app) - the wizard has left comments in the `<head>` near the Telerik assets that show the correct paths for a trial and commercial license.
79+
4380

4481

4582
## See Also
Loading

getting-started/vs-integration/introduction.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@ The Telerik Blazor Extensions provide the following advantages:
2121

2222
The Telerik UI for Blazor VS extensions support Visual Studio 2019.
2323

24-
You can get them from the:
25-
26-
* [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=TelerikInc.TelerikBlazorVSExtensions)
27-
* [Telerik UI for Blazor automated installer]({%slug installation/msi%})
24+
@[template](/_contentTemplates/common/general-info.md#vsx-download)
2825

2926
To access the VS extensions, go to the **Extensions** > **Telerik** > **Telerik UI for Blazor** menu.
3027

getting-started/vs-integration/new-project-wizard.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ This article demonstrates how to create a new application that has the Progress&
1212

1313
To create a new Telerik UI for Blazor application, use the **Create New Project Wizard**. The wizard detects all installed versions of Telerik UI for Blazor and lists them in the **Version** combobox&mdash;this enables you to start your project with the desired version. You can also [get the latest version]({%slug getting-started-vs-integration-latest-version%}) to make sure you are up to date.
1414

15+
## Get the Wizard
16+
17+
To use the **Create New Project Wizard**, install the Telerik UI for Blazor Visual Studio Extensions. @[template](/_contentTemplates/common/general-info.md#vsx-download)
18+
19+
20+
## Start the Wizard
21+
1522
To start the wizard, use either of the following approaches:
1623

1724
* Using the **Extensions** menu:

0 commit comments

Comments
 (0)