Skip to content

Commit 654659e

Browse files
authored
Update Visual Studio extention documentation (#2287)
* docs(common): update vs extention documentation * apply suggested changes
1 parent 085469b commit 654659e

17 files changed

+42
-64
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,14 @@ The configuration wizard handles the following tasks:
2424

2525
The **Theme Selection** page enables you to change the [CSS theme]({%slug themes-built-in%}) of your Telerik UI for Blazor application.
2626

27-
![Theme Selection menu in the Project Configuration Wizard](../vs-integration/images/configure-theme.png)
28-
2927
After selecting the desired theme, click **Next** to navigate to the [Project Settings](#project-settings) page.
3028

3129
## Project Settings
3230

33-
The **Project Settings** page allows you to enable or disable the [Telerik UI CDN support]({%slug common-features-cdn%}). Note that this can affect the future [upgrade process of the theme]({%slug getting-started-vs-integration-new-project%}#step-3-configure-additional-project-settings).
31+
The **Project Settings** page allows you to enable or disable:
3432

35-
![Project Settings dialog in the Project Configuration Wizard](../vs-integration/images/configure-settings.png)
33+
* The [Telerik UI CDN support]({%slug common-features-cdn%}). Note that this can affect the future [upgrade process of the theme]({%slug upgrade-tutorial%}#upgrade-process).
34+
* The [Font Icons]({%slug common-features-icons%}) in the project.
3635

3736
## See Also
3837

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

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,32 @@ Alternatively, instead of the context menu, you can use the VS **Extensions** me
5757
5858
![Start the Convert Project Wizard](images/vs-ext-convert-project-entry.png)
5959

60-
## Features
60+
## Converting the Project
6161

62-
The wizard provides you with the following options:
62+
Clicking the Convert to Telerik Application button opens the Convert Project Wizard and you will go through the following steps:
6363

64-
* The ability to download the latest available version.
65-
* A version selector so you can choose a particular version to add to the project.
66-
* A list with the versions found on your machine that you can choose from.
67-
* Whether to back up the project state before the conversion (in a folder called `<ProjectName>_Backup>_<timestamp>`).
64+
1. [Configure the project](#step-1-select-initial-project-configuration).
65+
1. [Select a visual theme](#step-2-select-theme).
66+
1. [Create a backup](#step-3-create-a-backup).
6867

69-
>caption The Convert Project Wizard Options
68+
### Step 1: Select Initial Project Configuration
7069

71-
![The Convert Project Wizard Options](images/convert-project-wizard-options.png)
70+
This screen provides the ability to:
71+
72+
* Download the latest available version.
73+
* Choose a particular version to add to the project.
74+
* Configure additional project settings like:
75+
* Load the required Telerik UI stylesheet and JS Interop file as [static assets]({%slug getting-started/what-you-need%}#css-theme-and-javascript-files) or from the [Telerik CDN]({%slug common-features-cdn%}).
76+
* Enable [localization]({%slug globalization-localization%}).
77+
* Use [font icons]({%slug common-features-icons%}) instead of the default SVG icons.
78+
79+
### Step 2: Select Theme
80+
81+
In this step, you can apply one of the available [themes]({%slug themes-built-in%}) to your project.
82+
83+
### Step 3: Create a Backup
84+
85+
You can choose to back up the project state before the conversion (in a folder called `<ProjectName>_Backup>_<timestamp>`).
7286

7387
## Troubleshooting
7488

@@ -80,14 +94,10 @@ When converting a project, you may encounter the following most common issues:
8094

8195
### Error Screen
8296

83-
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 WebAssembly 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.
97+
If you see an error screen in the wizard, make sure that you have selected the UI project in the Solution Explorer. For example, the Issue can occur in WebAssembly apps as they can include a Server and Shared projects, and only the Client project is the actual Blazor UI app that needs the Telerik components.
8498

8599
Some specific project settings can also cause an exception during conversion. The fastest solution is to [manually configure the project for the Telerik components]({%slug getting-started/what-you-need%}).
86100

87-
>caption Error screen when the project can't be converted
88-
89-
![The Convert Project Failed](images/convert-project-wizard-failed.png)
90-
91101
### Components Fail
92102

93103
The issue can manifest in a couple of ways:
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

getting-started/vs-integration/latest-version-retrieval.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,13 @@ Clicking the **Get Latest** button in the [Create New Project]({% slug getting-s
2424

2525
1. Click on the LOG IN button. This will open a browser window with a login form on the telerik.com website.
2626

27-
![Log into your Telerik account](images/click-to-log-in.png)
28-
2927
>tip For more information on the latest available versions, see the [Telerik UI for Blazor release notes](https://www.telerik.com/support/whats-new/blazor-ui/release-history).
3028
3129
1. Enter your Telerik credentials in the browser. If you do not have a [www.telerik.com](https://www.telerik.com) account, then create a new one.
3230
1. Return to Visual Studio and confirm any privacy-related requests.
3331
1. In the next dialog that appears, click the **Download** button.
3432

35-
![Confirming the download of the latest version dialog](images/download-new-version.png)
36-
37-
1. Return to the [Create New Project]({% slug getting-started-vs-integration-new-project %}) wizard and select the newly downloaded version from the drop-down menu.
38-
39-
![The new version is now available in the New Project wizard](images/new-version-in-new-project-wizard.png)
33+
1. Return to the [Create New Project]({% slug getting-started-vs-integration-new-project %}) wizard and select the newly downloaded version.
4034

4135
The Latest Version Acquirer tool downloads a `.zip` file that contains the latest Telerik UI for Blazor packages. By default, the file is saved in the `%APPDATA%\Telerik\Updates` folder. If the list with the offered packages gets too long and you do not need the prior versions, close VS and use the Windows Explorer to delete these distributions.
4236

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

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,20 @@ After you select the **Create New Project** option from the **Extensions** menu,
5858

5959
Clicking the **Create** button in this window opens the wizard and you will go through the following steps:
6060

61+
1. [Select Initial Project Configuration](#step-1-select-initial-project-configuration).
62+
1. [Select Project Template](#step-2-select-project-template).
63+
1. [Select a visual theme](#step-3-select-theme).
64+
6165
### Step 1: Select Initial Project Configuration
6266

6367
In this screen, you can choose:
6468

6569
* Target .NET framework
6670
* Hosting model&mdash;the options vary depending on the selected target framework.
71+
* Configure additional project settings like:
72+
* Load the required Telerik UI stylesheet and JS Interop file as [static assets]({%slug getting-started/what-you-need%}#css-theme-and-javascript-files) or from the [Telerik CDN]({%slug common-features-cdn%}). Note that this can affect the future [upgrade process of the theme]({%slug upgrade-tutorial%}#upgrade-process).
73+
* Enable [localization]({%slug globalization-localization%}).
74+
* Use [font icons]({%slug common-features-icons%}) instead of the default SVG icons.
6775
* Location from where the application will get the Telerik UI for Blazor package&mdash;[remote NuGet feed]({%slug installation/nuget%}) or local files.
6876
* Telerik UI for Blazor version.
6977

@@ -82,19 +90,7 @@ The **Create New Project** wizard provides the following project templates:
8290
* **Dashboard**&mdash;A basic dashboard layout that uses the TileLayout component for customizable dashboards, and showcases several ways individual blocks (tiles) can fetch data.
8391
* **Admin**&mdash;A small app that shows a dashboard for admin. The app uses some of the main Telerik UI components like the [Data Grid]({%slug grid-overview%}), [Chart]({%slug components/chart/overview%}), [TileLayout]({%slug tilelayout-overview%}), [Form]({%slug form-overview%}), and more.
8492

85-
### Step 3: Configure Additional Project Settings
86-
87-
This screen lets you choose:
88-
89-
* Whether to import the required Telerik UI stylesheet and JS Interop file by using the [static assets]({%slug getting-started/what-you-need%}#css-theme-and-javascript-files) or the [CDN method]({%slug common-features-cdn%}).
90-
* Whether to use [localization]({%slug globalization-localization%}) in the project or not.
91-
* Whether to use [Font Icons]({%slug common-features-icons%}) in the project or the default SVG icons.
92-
93-
#### Using Local Theme
94-
95-
When using a local theme, the CSS file is saved locally in the `wwwroot/lib/blazor-ui/styles` folder of the application. With this configuration, upgrading UI for Blazor requires you to [replace this CSS file manually]({%slug upgrade-tutorial%}).
96-
97-
### Step 4: Select Theme
93+
### Step 3: Select Theme
9894

9995
Finally, you can apply one of the available [themes]({%slug themes-built-in%}) to your project.
10096

getting-started/vs-integration/upgrade-wizard.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ The **Upgrade Project Wizard** upgrades the version of existing Telerik UI for B
2020

2121
The **Upgrade Information** step of the Upgrade Project Wizard describes the files and assemblies that will be upgraded.
2222

23-
![Upgrade Wizard Information Page](images/upgrade-wizard-information.png)
24-
2523
The Telerik Blazor Upgrade Wizard will do the following:
2624

2725
* Update the version of the referenced Blazor NuGet package. It will also update the package source in the solution-based NuGet config file.
@@ -35,47 +33,28 @@ The next page of the Upgrade Wizard lists all projects from the solution that us
3533

3634
>tip We recommend selecting all projects that reference UI for Blazor and upgrading them to the same product version.
3735
38-
![Upgrade Wizard Projects Selection](images/upgrade-wizard-projects.png)
39-
4036
## Upgrade Localization File
4137

4238
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.
4339

44-
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.
45-
46-
![Upgrade Wizard Localization File](images/upgrade-wizard-localization-file.png)
40+
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.
4741

4842
## Create Backup
4943

5044
You can create a backup before running the upgrade wizard by selecting the **Create a backup before upgrading** option.
5145

52-
>When the project and solution are placed in the same directory, the default backup location is set to the **%USERPROFILE%\Documents** folder.
53-
54-
![Upgrade Wizard Backup](images/upgrade-wizard-backup.png)
55-
46+
>When the project and solution are placed in the same directory, the default backup location is set to the `%USERPROFILE%\Documents` folder.
5647
5748
## Upgrade Log
5849

59-
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.
60-
61-
![Upgrade Wizard Log](images/upgrade-wizard-backup.png)
50+
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 open 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.
6251

6352
## Troubleshooting
6453

65-
The following common problems might occur when upgrading a project:
66-
67-
* The [localization file is read-only or does not exists](#missing-localization-file).
68-
* The [**Finish** button is disabled](#finish-button-is-disabled).
69-
70-
### Missing Localization file
71-
72-
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.
73-
74-
![Upgrade Wizard Localization File](images/upgrade-wizard-localization-file-invalid.png)
75-
76-
### Finish Button is Disabled
54+
The **Finish** button will display a tooltip, indicating a page error when:
7755

78-
If **Create a backup before upgrading** option is selected, and the **Backup location** is empty, the **Finish** button is disabled.
56+
* The **Upgrade the localization file** option is selected and the pointed directory is empty or the file is read-only.
57+
* The **Create a backup before upgrading** option is selected, and the backup location is empty.
7958

8059
## See Also
8160

0 commit comments

Comments
 (0)