Skip to content

Commit d08a9e3

Browse files
yordan-mitevdimodi
authored andcommitted
Apply new naming and update URL
1 parent 08841d3 commit d08a9e3

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

_contentTemplates/common/get-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525

2626
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).
2727

28-
1. Go to the [NuGet Keys](https://www.telerik.com/account/downloads/nuget-keys) page in your Telerik account.
28+
1. Go to the [API Keys](https://www.telerik.com/account/downloads/api-keys) page in your Telerik account.
2929
1. Click **Generate New Key +**.
3030
1. In the **Key Note** field, add a note that describes the API key.
3131
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.
32+
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.
3333
1. Store the generated NuGet API key as you will need it in the next steps.
3434

3535
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.
@@ -42,15 +42,15 @@ In this tutorial, you will use the [Telerik NuGet feed](slug:installation/nuget)
4242

4343
To generate your NuGet API key:
4444

45-
1. Go to the [NuGet Keys](https://www.telerik.com/account/downloads/nuget-keys) page in your Telerik account.
45+
1. Go to the [API Keys](https://www.telerik.com/account/downloads/api-keys) page in your Telerik account.
4646

4747
1. Click **Generate New Key +**.
4848

4949
1. In the **Key Note** field, add a note that describes the API key.
5050

5151
1. Click **Generate Key**.
5252

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.
53+
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.
5454

5555
1. Store the generated NuGet API key as you will need it in the next steps.
5656

deployment/ci-cd-license-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ steps:
124124
TELERIK_LICENSE: ${{ "{{ secrets.Telerik_License_Key }}" }}
125125
````
126126

127-
Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.
127+
Also see [Using API Keys](slug:deployment-nuget#using-api-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.
128128

129129
## Docker
130130

deployment/nuget-keys.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Restoring NuGet Packages in CI
33
page_title: Restoring NuGet Packages in CI
4-
description: Get started with Telerik UI for Blazor and use NuGet Keys to authenticate with the Telerik NuGet server and restore packages in your CI or desktop environment.
4+
description: Get started with Telerik UI for Blazor and use API Keys to authenticate with the Telerik NuGet server and restore packages in your CI or desktop environment.
55
slug: deployment-nuget
66
position: 10
77
---
@@ -10,35 +10,35 @@ 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-
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.
13+
When you need to restore the [Telerik NuGet packages](slug:getting-started/what-you-need#nuget-packages) as part of your CI, using API Keys provides a secure way to authenticate. This method does not require you to provide your Telerik credentials anywhere in the CI workflow. An API key has a limited scope and can be used only with the Telerik NuGet server. If any of your API Keys is compromised, you can quickly delete it and create a new one.
1414

15-
## Generating NuGet Keys
15+
## Generating API Keys
1616

1717
@[template](/_contentTemplates/common/get-started.md#generate-nuget-api-key)
1818

19-
## Storing NuGet Keys
19+
## Storing API Keys
2020

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.
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). An API 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.
2222
23-
To protect the NuGet Key, store it as a secret environment variable. The exact store steps depend on your workflow and environment:
23+
To protect the API key, store it as a secret environment variable. The exact store steps depend on your workflow and environment:
2424

2525
* In GitHub Actions, save the key as a [GitHub Actions Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).
26-
* In Azure DevOps, save the key as a [secret Azure DevOps pipeline variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/set-secret-variables). If you use an Azure DevOps Service connection instead of secret environment variables, enter `api-key` in the username field and the NuGet key as the password in the **New NuGet service connection** form editor.
26+
* In Azure DevOps, save the key as a [secret Azure DevOps pipeline variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/set-secret-variables). If you use an Azure DevOps Service connection instead of secret environment variables, enter `api-key` in the username field and the API key as the password in the **New NuGet service connection** form editor.
2727
* In Docker images, save the key as a [Docker secret](https://docs.docker.com/tags/secrets/).
2828

29-
For more details on storing and protecting your NuGet Key, check the [Announcing NuGet Keys](https://www.telerik.com/blogs/announcing-nuget-keys) blog post by Lance McCarthy.
29+
For more details on storing and protecting your API key, check the [Announcing NuGet Keys](https://www.telerik.com/blogs/announcing-nuget-keys) blog post by Lance McCarthy.
3030

3131
The examples below assume that the secret environment variable name is `TELERIK_NUGET_KEY`.
3232

3333

34-
## Using NuGet Keys
34+
## Using API Keys
3535

36-
There are two common ways to use a [stored NuGet key](#storing-nuget-keys) with the Telerik NuGet server during a build:
36+
There are two common ways to use a [stored API key](#storing-api-keys) with the Telerik NuGet server during a build:
3737

3838
* [Using a NuGet.Config file](#using-a-nuget-config-file)
3939
* [Using only CLI commands](#using-net-cli-commands)
4040

41-
For more information on how to use NuGet keys in a build, check the [Announcing NuGet Keys](https://www.telerik.com/blogs/announcing-nuget-keys) blog post by Lance McCarthy.
41+
For more information on how to use API keys in a build, check the [Announcing NuGet Keys](https://www.telerik.com/blogs/announcing-nuget-keys) blog post by Lance McCarthy.
4242

4343
### Using a NuGet.Config File
4444

@@ -65,7 +65,7 @@ In your `NuGet.Config` file, set the `Username` value to `api-key` and the `Clea
6565

6666
### Using .NET CLI Commands
6767

68-
You can use the .NET CLI `add source` or `update source` commands to set the credentials of a package source. This CLI approach is applicable if your CI system doesn't support [environment variable secrets](#storing-nuget-keys) or if you do not [use a custom `NuGet.Config`](#using-a-nuget-config-file).
68+
You can use the .NET CLI `add source` or `update source` commands to set the credentials of a package source. This CLI approach is applicable if your CI system doesn't support [environment variable secrets](#storing-api-keys) or if you do not [use a custom `NuGet.Config`](#using-a-nuget-config-file).
6969

7070
* To set the credentials in Azure DevOps:
7171

installation/nuget.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can set up the remote Telerik NuGet feed in the following ways:
2222

2323
Regardless of how you set up the Telerik NuGet feed, you must first [generate a NuGet API key](#generate-a-nuget-api-key) needed for the authentication.
2424

25-
>warning Never hard-code your Telerik NuGet API keys in a `NuGet.Config` file in a GitHub repository, Docker image, or any location that may be accessed by unauthorized parties. A NuGet key is valuable and bad actors can use it to access the NuGet packages that are licensed under your account. A credentials abuse can lead to a review of the affected Telerik account.
25+
>warning Never hard-code your Telerik NuGet API keys in a `NuGet.Config` file in a GitHub repository, Docker image, or any location that may be accessed by unauthorized parties. An API key is valuable and bad actors can use it to access the NuGet packages that are licensed under your account. A credentials abuse can lead to a review of the affected Telerik account.
2626
2727
For NuGet-related issues, see [NuGet Feed Troubleshooting](slug:troubleshooting-nuget).
2828

troubleshooting/nuget-feed.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ If you suspect that your saved credentials are wrong, use the following steps to
6464
* No provided credentials
6565
* Incorrect password
6666
* [Correct password with unescaped special characters](#special-characters-in-the-password)
67-
* Using an invalidated (removed) [Telerik NuGet API key](slug:installation/nuget#use-nuget-api-key), which no longer exists in <a href="https://www.telerik.com/account/downloads/nuget-keys" target="_blank">your Telerik account</a>.
67+
* Using an invalidated (removed) [Telerik NuGet API key](slug:installation/nuget#use-nuget-api-key), which no longer exists in <a href="https://www.telerik.com/account/downloads/api-keys" target="_blank">your Telerik account</a>.
6868
* Using a valid Telerik NuGet API key with the wrong username. It must be `api-key`.
6969

7070
An easy way to verify your credentials is to [access the Telerik NuGet server directly in the web browser](#tips-for-handling-common-nuget-issues). Then, depending on your setup, check or update your credentials in:
7171

7272
* The applicable `NuGet.Config` file. There may be <a href="https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior" target="_blank">multiple such files on the device</a>.
7373
* [Windows Credential Manager](#removing-saved-credentials)
74-
* In a [CI/CD workflow](slug:deployment-nuget#using-net-cli-commands), which [obtains the credentials from a secret](slug:deployment-nuget#storing-nuget-keys).
74+
* In a [CI/CD workflow](slug:deployment-nuget#using-net-cli-commands), which [obtains the credentials from a secret](slug:deployment-nuget#storing-api-keys).
7575

7676
### Special Characters in the Password
7777

0 commit comments

Comments
 (0)