Skip to content

Commit eaa8048

Browse files
committed
docs(Common): Improve Getting Started experience for non-Windows devs
1 parent 562219d commit eaa8048

File tree

7 files changed

+39
-46
lines changed

7 files changed

+39
-46
lines changed

_contentTemplates/common/get-started.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,51 @@ Whenever you need to authenticate your system with the Telerik NuGet server, use
3636
#end
3737

3838
#add-nuget-feed
39-
## Step 3: Add the Telerik NuGet Feed to Visual Studio
39+
## Step 3: Add the Telerik NuGet Feed
4040

41-
In this tutorial, you will use the [Telerik NuGet feed](slug:installation/nuget) to download the UI for Blazor components. This NuGet feed is private and requires you to authenticate with a NuGet API key.
41+
In this tutorial, you will use the [Telerik NuGet server](slug:installation/nuget) to download the UI for Blazor components. The NuGet feed is private and requires you to authenticate with a NuGet API key.
4242

43-
To generate your NuGet API key:
43+
### Generate NuGet API Key
4444

4545
1. Go to the [API Keys](https://www.telerik.com/account/downloads/api-keys) page in your Telerik account.
46-
4746
1. Click **Generate New Key +**.
48-
4947
1. In the **Key Note** field, add a note that describes the API key.
50-
5148
1. Click **Generate Key**.
52-
5349
1. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **API Keys** page displays only a portion of the key.
54-
5550
1. Store the generated NuGet API key as you will need it in the next steps.
5651

57-
Next, add the Telerik NuGet feed to Visual Studio:
58-
59-
1. In Visual Studio and go to **Tools** > **NuGet Package Manager** > **Package Manager Settings**.
52+
Next, add the Telerik NuGet feed to your local development environment:
6053

61-
1. Select **Package Sources** and then click the **+** button to add a new package source.
54+
* [Visual Studio on Windows](#visual-studio)
55+
* [All IDEs and operating systems](#all-ides-and-operating-systems)
6256

63-
1. Enter a **Name** for the new package source, for example, `telerik.com`.
57+
>tip For more information on the Telerik NuGet packages and download options, check [section NuGet Packages in the Workflow article](slug:getting-started/what-you-need#nuget-packages).
6458
65-
1. Add the `https://nuget.telerik.com/v3/index.json` URL as a **Source**. Click **OK**.
59+
### Visual Studio
6660

67-
![Add the Telerik NuGet Feed in Visual Studio](images/telerik-nuget-feed.png)
61+
The following approach will store the Telerik NuGet server URL in your [global `NuGet.Config` file](https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior), and save your NuGet API key in the Windows Credential Manager.
6862

63+
1. Go to **Tools** > **NuGet Package Manager** > **Package Manager Settings**.
64+
1. Select **Package Sources** and then click the **+** or **Add** button.
65+
1. Enter a **Name** for the new package source. The examples in this documentation usually use `TelerikOnlineFeed`.
66+
1. Add `https://nuget.telerik.com/v3/index.json` as a **Source** URL. Click **OK** or **Save**.
6967
1. Whenever Visual Studio displays a dialog to enter credentials for `nuget.telerik.com`, use `api-key` as the username and your NuGet API key as the password.
7068

71-
>tip For alternative NuGet package download options, check the [Workflow article](slug:getting-started/what-you-need).
69+
### All IDEs and Operating Systems
70+
71+
Run [`dotnet nuget add source`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-add-source) in your preferred command line interface (cmd, Terminal, PowerShell, Bash). The command will store the Telerik NuGet server URL and your NuGet API key in your [global `NuGet.Config` file](https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior).
72+
73+
Replace `<YOUR-NUGET-API-KEY>` with the API key that you [generated previously](#generate-nuget-api-key).
74+
75+
>caption Use the .NET CLI to add the Telerik NuGet source
76+
77+
````SH.skip-repl
78+
dotnet nuget add source https://nuget.telerik.com/v3/index.json \
79+
--name TelerikOnlineFeed \
80+
--username api-key \
81+
--password <YOUR-NUGET-API-KEY> \
82+
--store-password-in-clear-text
83+
````
7284

7385
#end
7486

getting-started/client-blazor.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,14 @@ This article explains how to get the <a href = "https://www.telerik.com/blazor-u
3232

3333
## Step 2: Create a New Project
3434

35-
1. Open Visual Studio and select **Create a new project**.
36-
37-
1. Select the **Blazor WebAssembly App** project type, enter a name for your project, and then click **Next**.
38-
39-
1. Select the **ASP.NET Core hosted** checkbox and the desired framework, and then click **Create**.
35+
* To create a new Blazor app, open your preferred IDE or [run the `dotnet new` .NET CLI command](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-new).
36+
* Use the [**Blazor WebAssembly Standalone App**](https://learn.microsoft.com/en-us/aspnet/core/blazor/project-structure) project template.
4037

4138
@[template](/_contentTemplates/common/get-started.md#add-nuget-feed)
4239

4340
## Step 4: Install the Telerik UI for Blazor Components
4441

45-
1. Right-click the `.Client` project in the solution and select **Manage NuGet Packages**.
46-
47-
![Manage NuGet Packages](images/manage-nuget-packages-for-client-app.png)
48-
49-
2. Install the Telerik Blazor NuGet package:
50-
51-
1. Select the `telerik.com` **Package source** that you [added earlier](#step-3-add-the-telerik-nuget-feed-to-visual-studio). As this is a private NuGet feed, you must authenticate using `api-key` as the username and [your NuGet API key](#step-3-add-the-telerik-nuget-feed-to-visual-studio) as the password.
52-
1. Select the **Browse** tab, find the `Telerik.UI.for.Blazor` NuGet package, and click **Install**.
53-
54-
![Add Telerik Blazor Package to Client Project](images/add-telerik-nuget-to-client-app.png)
42+
Add the `Telerik.UI.for.Blazor` NuGet package from the package source that you [added earlier](#step-3-add-the-telerik-nuget-feed) to every project that will use the Telerikk Blazor components. When prompted, authenticate using `api-key` as the username and [your NuGet API key](#generate-nuget-api-key) as the password.
5543

5644
## Step 5: Enable the Blazor UI Components
5745

-10.3 KB
Binary file not shown.
-8.97 KB
Binary file not shown.
-39.3 KB
Binary file not shown.
-11.2 KB
Binary file not shown.

getting-started/web-app.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,16 @@ This article explains how to use the Telerik UI for Blazor components in a Blazo
3636

3737
## Step 2: Create a New Project
3838

39-
1. Open Visual Studio and select **Create a new project**.
39+
To create a new Blazor app:
4040

41-
1. Select the [**Blazor Web App**](https://learn.microsoft.com/en-us/aspnet/core/blazor/project-structure?view=aspnetcore-8.0#blazor-web-app) project type, enter a name for your project, and then click **Next**.
42-
43-
1. Select the desired [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and **Global** Interactivity location. Global interactivity ensures easier setup and usage of the Telerik components.
44-
45-
1. Click **Create**.
41+
1. Open your preferred IDE or [run the `dotnet new` .NET CLI command](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-new).
42+
1. Use the [**Blazor Web App**](https://learn.microsoft.com/en-us/aspnet/core/blazor/project-structure) project template.
43+
1. Select the desired [interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes).
44+
1. Enable **Global** Interactivity location.
4645

4746
### Interactive Render Mode
4847

49-
> Telerik UI for Blazor requires interactive render mode. Using [**Global** Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-9.0#apply-a-render-mode-to-the-entire-app) is highly recommended.
48+
> Telerik UI for Blazor requires interactive render mode. Using [**Global** Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-9.0#apply-a-render-mode-to-the-entire-app) is highly recommended, as it ensures easier setup and usage of the Telerik components.
5049
> The Telerik Blazor components will not respond to user actions and the Blazor framework will not refresh their UI in [Static server-side rendering mode (static SSR)](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-9.0#static-server-side-rendering-static-ssr). Telerik Blazor components with JavaScript rendering (Barcodes, Charts, Gauges, Maps, and QR Codes) will not render in static SSR at all.
5150
>
5251
> The `Account` section in the Blazor Web App template with identity is static by design. Most Telerik Blazor components cannot work in this section.
@@ -55,15 +54,9 @@ This article explains how to use the Telerik UI for Blazor components in a Blazo
5554

5655
## Step 4: Install the Telerik UI for Blazor Components
5756

58-
1. To include the Telerik component library, right-click each project that will use Telerik Blazor components, and select **Manage NuGet Packages**.
59-
60-
* Apps with interactive Server render mode need the Telerik Nuget package in the server project.
61-
* Apps with global interactive Auto or WebAssembly render mode need the Telerik NuGet package in the client project.
62-
63-
1. Install the Telerik Blazor NuGet package:
57+
Add the `Telerik.UI.for.Blazor` package from the NuGet source that you [added earlier](#step-3-add-the-telerik-nuget-feed) to every project that will use the Telerik Blazor components. Apps with global interactive **Auto** or **WebAssembly** render mode need the Telerik NuGet package in the `Client` project.
6458

65-
1. Select the `telerik.com` **Package source** that you [added earlier](#step-3-add-the-telerik-nuget-feed-to-visual-studio). As this is a private NuGet feed, you must authenticate using `api-key` as the username and [your NuGet API key](#step-3-add-the-telerik-nuget-feed-to-visual-studio) as the password.
66-
1. Select the **Browse** tab, find the `Telerik.UI.for.Blazor` NuGet package, and click **Install**.
59+
When prompted, authenticate using `api-key` as the username and [your NuGet API key](#generate-nuget-api-key) as the password.
6760

6861
## Step 5: Enable the Blazor UI Components
6962

0 commit comments

Comments
 (0)