Skip to content

Commit 08841d3

Browse files
yordan-mitevdimodi
authored andcommitted
Address feedback from review
1 parent a001ad6 commit 08841d3

File tree

6 files changed

+38
-38
lines changed

6 files changed

+38
-38
lines changed

_contentTemplates/common/get-started.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,40 @@
2121
2222
#end
2323

24+
#generate-nuget-api-key
25+
26+
As the Telerik NuGet server requires authentication, the first step is to obtain an API key that you will use instead of a password. Using an API key instead of a password is a more secure approach, especially when working with [.NET CLI](#use-the-net-cli) or the [`NuGet.Config` file](#edit-the-nugetconfig-file).
27+
28+
1. Go to the [NuGet Keys](https://www.telerik.com/account/downloads/nuget-keys) page in your Telerik account.
29+
1. Click **Generate New Key +**.
30+
1. In the **Key Note** field, add a note that describes the API key.
31+
1. Click **Generate Key**.
32+
1. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **NuGet Keys** page displays only a portion of the key.
33+
1. Store the generated NuGet API key as you will need it in the next steps.
34+
35+
Whenever you need to authenticate your system with the Telerik NuGet server, use `api-key` as the username and your generated API key as the password.
36+
#end
2437

2538
#add-nuget-feed
2639
## Step 3: Add the Telerik NuGet Feed to Visual Studio
2740

28-
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 your Telerik user name and password:
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.
42+
43+
To generate your NuGet API key:
44+
45+
1. Go to the [NuGet Keys](https://www.telerik.com/account/downloads/nuget-keys) page in your Telerik account.
46+
47+
1. Click **Generate New Key +**.
48+
49+
1. In the **Key Note** field, add a note that describes the API key.
50+
51+
1. Click **Generate Key**.
52+
53+
1. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **NuGet Keys** page displays only a portion of the key.
54+
55+
1. Store the generated NuGet API key as you will need it in the next steps.
56+
57+
Next, add the Telerik NuGet feed to Visual Studio:
2958

3059
1. In Visual Studio and go to **Tools** > **NuGet Package Manager** > **Package Manager Settings**.
3160

@@ -37,9 +66,9 @@ In this tutorial, you will use the [Telerik NuGet feed](slug:installation/nuget)
3766

3867
![Add the Telerik NuGet Feed in Visual Studio](images/telerik-nuget-feed.png)
3968

40-
1. Whenever Visual Studio displays a dialog to enter credentials for `nuget.telerik.com`, use your Telerik account email and password.
69+
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.
4170

42-
>tip For alternative NuGet package download options, check the [Workflow article](slug:getting-started/what-you-need). You can also [authenticate with `nuget.telerik.com` with an API key](slug:installation/nuget#use-nuget-api-key).
71+
>tip For alternative NuGet package download options, check the [Workflow article](slug:getting-started/what-you-need).
4372
4473
#end
4574

deployment/nuget-keys.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,15 @@ position: 10
1010

1111
This article describes how to use token-based authentication for the Telerik NuGet feed. You will learn how to create and use NuGet API keys to restore Telerik NuGet packages in your Continuous Integration (CI) workflow.
1212

13-
The [Telerik NuGet server](slug:installation/nuget) provides two ways to authenticate:
14-
15-
* Basic authentication with your Telerik username and password.
16-
* Token-based authentication with a NuGet API key.
17-
18-
When you need to restore the [Telerik NuGet packages](slug:getting-started/what-you-need#nuget-packages) as part of your CI, a NuGet API key is the more secure way to authenticate. This method does not require you to provide your Telerik credentials anywhere in the CI workflow. A NuGet Key has a limited scope and can be used only with the Telerik NuGet server. If any of your NuGet keys is compromised, you can quickly delete it and create a new one.
19-
13+
When you need to restore the [Telerik NuGet packages](slug:getting-started/what-you-need#nuget-packages) as part of your CI, using NuGet keys provides a secure way to authenticate. This method does not require you to provide your Telerik credentials anywhere in the CI workflow. A NuGet Key has a limited scope and can be used only with the Telerik NuGet server. If any of your NuGet keys is compromised, you can quickly delete it and create a new one.
2014

2115
## Generating NuGet Keys
2216

23-
1. In your Telerik account, go to the [**Manage NuGet Keys**](https://www.telerik.com/account/downloads/nuget-keys) page.
24-
25-
![Manage NuGet Keys](../deployment/images/manage-nuget-keys.png)
26-
27-
1. Click **Generate New Key**.
28-
29-
1. Enter a name for the NuGet Key and click **Generate Key**.
30-
31-
1. To copy the key, click **Copy and Close**. Once you close the popup dialog, you can no longer copy the generated key. For security reasons, the **NuGet Keys** page displays only a portion of the key.
32-
33-
![Copy Generated NuGet Key](../deployment/images/copy-nuget-key.png)
34-
17+
@[template](/_contentTemplates/common/get-started.md#generate-nuget-api-key)
3518

3619
## Storing NuGet Keys
3720

38-
>warning Never check in Telerik account credentials or a NuGet API key with your source code or leave them publicly visible in plain text (for example, in a `NuGet.Config` file). A NuGet key is valuable and bad actors can use it to access the NuGet packages that are licensed under your account. A key abuse can lead to a review of the affected Telerik account.
21+
>warning Never check in a NuGet API key with your source code or leave them publicly visible in plain text (for example, in a `NuGet.Config` file). A NuGet key is valuable and bad actors can use it to access the NuGet packages that are licensed under your account. A key abuse can lead to a review of the affected Telerik account.
3922
4023
To protect the NuGet Key, store it as a secret environment variable. The exact store steps depend on your workflow and environment:
4124

getting-started/client-blazor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This article explains how to get the <a href = "https://www.telerik.com/blazor-u
4848

4949
2. Install the Telerik Blazor NuGet package:
5050

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 with your [Telerik account](https://www.telerik.com/account/) user name and password.
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.
5252
1. Select the **Browse** tab, find the `Telerik.UI.for.Blazor` NuGet package, and click **Install**.
5353

5454
![Add Telerik Blazor Package to Client Project](images/add-telerik-nuget-to-client-app.png)

getting-started/web-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ This article explains how to use the Telerik UI for Blazor components in a Blazo
6262

6363
1. Install the Telerik Blazor NuGet package:
6464

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 with your [Telerik account](https://www.telerik.com/account/) username and password.
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.
6666
1. Select the **Browse** tab, find the `Telerik.UI.for.Blazor` NuGet package, and click **Install**.
6767

6868
## Step 5: Enable the Blazor UI Components
-9.75 KB
Binary file not shown.

installation/nuget.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,7 @@ For information on automated builds, CI and CD, see [CI, CD, Build Server](slug:
3030

3131
## Generate a NuGet API Key
3232

33-
As the Telerik NuGet server requires authentication, the first step is to obtain an API key that you will use instead of a password. Using an API key instead of a password is a more secure approach, especially when working with [.NET CLI](#use-the-net-cli) or the [`NuGet.Config` file](#edit-the-nugetconfig-file).
34-
35-
1. Go to the [NuGet Keys](https://www.telerik.com/account/downloads/nuget-keys) page in your Telerik account.
36-
1. Click **Generate New Key +**.
37-
38-
![Manage NuGet Keys](../installation/images/account-generate-nuget-api-key.png)
39-
40-
1. In the **Key Note** field, add a note that describes the API key.
41-
1. Click **Generate Key**.
42-
1. Select **Copy and Close**. Once you close the window, you can no longer copy the generated key. For security reasons, the **NuGet Keys** page displays only a portion of the key.
43-
1. Store the generated NuGet API key as you will need it in the next steps.
44-
45-
Whenever you need to authenticate your system with the Telerik NuGet server, use `api-key` as the username and your generated API key as the password.
33+
@[template](/_contentTemplates/common/get-started.md#generate-nuget-api-key)
4634

4735
## Use Visual Studio
4836

0 commit comments

Comments
 (0)