Skip to content

Commit 9e82fb8

Browse files
authored
Edit GS and Installation Articles (#1677)
* Edit GS and Installation Articles * Use list auto-numbering
1 parent 3ce3440 commit 9e82fb8

File tree

5 files changed

+50
-52
lines changed

5 files changed

+50
-52
lines changed

getting-started/first-steps-integrating.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ The steps to accomplish the installation of the Telerik Reporting controls and s
3434

3535
## Step 2: Create, Populate, and Style the Sample Report
3636

37-
The steps to create, populate with data and style the report are fully described in the steps 2 to 5 from the article [first steps guide on designing the Telerik report]({%slug telerikreporting/getting-started/first-steps%}#step-2-create-the-sample-report).
37+
Next, create the report that you will integrate in your web application. The steps required to create, populate with data, and style the report are described in the [first steps guide on designing the Telerik report]({%slug telerikreporting/getting-started/first-steps%}#step-2-create-the-sample-report).
3838

39-
In addition, you will only need to save the report as `DemoReport.trdp`.
39+
Once you have your report, save it as `DemoReport.trdp`. In the next step, you will integrate the TRDP report in the application.
4040

4141
## Step 3: Integrate and Display the Report
4242

4343
In this final step, you'll integrate your report in an ASP.NET Core web application in .NET 6 and display the project with the HTML5 Report Viewer.
4444

4545
1. Open __Visual Studio 2022__. From the __Start__ window, choose __Create a new project__.
4646

47-
1. Select __ASP.NET Core Web App__ and name it __TelerikWebApp__. In the __Additional information__ window, select __.NET6.0(Long-term support)__ and leave the rest of the settings as default. Click __Create__.
47+
1. Select __ASP.NET Core Web App__ and name it __TelerikWebApp__. In the __Additional information__ window, select __.NET 8.0 (Long-term support)__ and leave the rest of the settings as default. Click __Create__.
4848

4949
1. Right-click the project. Select __Add__ > __New Item__ > __Telerik HTML5 Report Viewer Page [version]__. Name the file `index.html`.
5050

getting-started/installation/adding-private-nuget-feed.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Adding the Private Telerik NuGet Feed
3-
page_title: Adding Telerik NuGet Feed to VS with Package Manager or CLI
2+
title: Adding the Telerik NuGet Feed
3+
page_title: Adding Telerik NuGet Feed
44
description: "Get up and running with Telerik Reporting and learn how to add quickly and easy the Telerik private NuGet feed to Visual Studio with the NuGet Package Manager or NuGet CLI in this step-by-step tutorial."
55
slug: telerikreporting/using-reports-in-applications/how-to-add-the-telerik-private-nuget-feed-to-visual-studio
66
previous_url: /using-reports-in-applications/how-to-add-the-telerik-private-nuget-feed-to-visual-studio, /add-the-telerik-private-nuget-feed-to-visual-studio
@@ -9,19 +9,13 @@ published: True
99
position: 5
1010
---
1111

12-
# Adding the Telerik Private NuGet Feed to VS
12+
# Adding the Telerik NuGet Feed to Your System
1313

14-
> The old **https://nuget.telerik.com/nuget** server is deprecated and we encourage our clients to switch to the v3 API. The new v3 API is faster, lighter, and reduces the number of requests from NuGet clients. The **NuGet v2** server at https://nuget.telerik.com/nuget will be sunset in **November 2024**. The new v3 protocol offers faster package searches and restores, improved security, and more reliable infrastructure. To redirect your feed to the NuGet v3 protocol, all you have to do is to change your NuGet package source URL to https://nuget.telerik.com/v3/index.json.
14+
Telerik maintains a publicly accessible NuGet server, providing a collection of NuGet packages to authenticated users. You can add the NuGet feed to your system by using [Visual Studio's NuGet package manager](#setup-in-visual-studio) or the [NuGet CLI](#setup-with-nuget-cli).
1515

16-
Telerik provides NuGet packages from the private Telerik NuGet feed which you can add to the Visual Studio NuGet package manager.
16+
To access the NuGet server, you need an active license for Telerik Reporting (trial or commercial).
1717

18-
## Prerequisites
19-
20-
* Visual Studio 2012 or later.
21-
22-
* Valid Telerik Reporting trial or commercial license.
23-
24-
## Setup
18+
## Setup in Visual Studio
2519

2620
1. Open Visual Studio.
2721
1. Go to __Tools__ > __NuGet Package Manager__ > __Package Manager Settings__, select __Package Manager Sources__ and click the __+__ button.
@@ -36,18 +30,18 @@ Telerik provides NuGet packages from the private Telerik NuGet feed which you ca
3630
1. In the upper right-hand corner of the __Manage Packages for Solution__ window, select the Telerik __Package source__ that you just added.
3731
1. Depending on your Visual Studio version, choose the __Online__ or __Browse__ list of packages.
3832
1. In the Windows **Authentication** dialog, enter your Telerik credentials. For example, **user: my.name@my.company.com** and **password: myPassPhraseForTelerikDotCom**.
39-
1. Enter your credentials only once by selecting the __Remember my password__ checkbox.
33+
1. Enter your credentials only once by selecting the __Remember my password__ checkbox. You may need to escape some [special characters in the password](#handling-special-characters-in-password).
4034

4135
>caption Enter your Telerik.com credentials to access the Telerik NuGet feed
4236

4337
![Telerik.com credentials form to access the Telerik NuGet Feed](images/nuget-credentials.png)
4438

45-
Now all the packages that are licensed to the above users are available in the Visual Studio NuGet Package manager.
46-
47-
> If you work with Visual Studio Code on Linux or Mac OS, use the Nuget CLI to set up the Telerik NuGet feed.
39+
After adding the Telerik server, all packages licensed to the authenticated user become available in the Visual Studio NuGet package manager.
4840

4941
## Setup with NuGet CLI
5042

43+
If you work with Visual Studio Code on Linux or Mac OS, use the Nuget CLI to set up the Telerik NuGet feed.
44+
5145
1. Download the latest [NuGet executable](https://dist.nuget.org/win-x86-commandline/latest/nuget.exe).
5246
1. Open a Command Prompt and change the path to the `nuget.exe` location.
5347
1. The command from the example below stores a token in the `%AppData%\NuGet\NuGet.config` file. Your original credentials cannot be obtained from this token.
@@ -76,6 +70,22 @@ NuGet Sources Update -Name "telerik.com" -Source "https://nuget.telerik.com/v3/i
7670
````
7771
7872
73+
## Handling Special Characters in Password
74+
75+
If your password contains a special character, those characters need to be escaped or it may fail authentication resulting in *Error 401 login failure* from the NuGet server. A common character that needs to be escaped is the ampersand (`&`), but it can be as unique as the section character (`§`). There are two ways to handle this.
76+
77+
1. Change the password so that it only includes characters that do not need to be escaped
78+
1. HTML encodes the password so the special characters are escaped (e.g. `my§uper&P@§§word` becomes `my§uper&P@§§word`).
79+
80+
We strongly discourage entering your password into an online encoder utility, use Powershell instead. Here's one example:
81+
82+
Add-Type -AssemblyName System.Web
83+
[System.Web.HttpUtility]::HtmlEncode('my§uper&P@§§word')
84+
85+
Result:
86+
87+
![Powershell Encoding of a Password containing special characters](images/PowerShellEncodingNugetPassword.png)
88+
7989
## See Also
8090
8191
* [Restoring NuGet Packages in Your CI Workflow]({%slug using-nuget-keys%})

getting-started/installation/download-preview-release.md

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

1111
# Preview Release
1212

13-
The Preview is a minor release for Telerik Reporting assemblies, that is uploaded between the major releases (Q1, Q2, Q3, and Q4). The Preview is released on demand so its frequency vary from none to several versions between two major releases. The purpose of the Preview is to allow the users to test the latest bug fixes before the major release.
13+
A preview release is a minor release with bug fixes that is published between the major releases (Q1, Q2, Q3, and Q4). Preview releases are published on demand and have no release cadence.
14+
15+
If a preview version gets released, it remains available for download only until the release of the next official version. Once the official version is published, the preview that preceded it is removed from the [Downloads](https://www.telerik.com/account/downloads/product-download?product=REPORTING) section of your Telerik account.
1416

1517
## Downloading the Preview Release
1618

17-
The previews are available only if they are released after an official release. Once a new official version is out and no previews are released afterwards, the previous previews are no longer available.
19+
The preview versions are available in the [Downloads](https://www.telerik.com/account/downloads/product-download?product=REPORTING) section of your Telerik account where you can select your preferred distribution asset type: NuGet packages, MSI, or a ZIP archive.
20+
21+
To download a preview release:
1822

19-
The Preview is __available as a NuGet__ package. Note that the Preview packages are not uploaded on the [Telerik NuGet Feed]({%slug telerikreporting/using-reports-in-applications/how-to-add-the-telerik-private-nuget-feed-to-visual-studio%}), but are available only as [local nuget package]({%slug setup-local-nuget-feed%}).
23+
1. Go to the Telerik Reporting [Downloads page](https://www.telerik.com/account/downloads/product-download?product=REPORTING).
2024

21-
Alternatively, you can __download the Preview assemblies__ from [your telerik.com account](https://www.telerik.com/account/).
25+
1. Click the __Download__ button in the __Latest Preview__ banner.
2226

23-
1. Go to the Telerik Reporting for Reporting product [download page](https://www.telerik.com/account/downloads/product-download?product=REPORTING).
24-
25-
2. Click on the __Download__ button in the __Latest Preview__ banner. This will download an archive with the Reporting __assemblies__.
27+
1. (Optional) To get a specific version of the preview (if multiple versions are available), click the __Previews__ tab on the download page. Then, select a version from the list.
2628

27-
To get a specific version of the Preview, open the __Previews__ tab on the download page. Then, select a version from the list.
29+
![Telerik Reporting Progress Site for Reporting Preview Tab](images/TelerikReportingLastestPreview.png)
2830

29-
![Telerik Reporting Progress Site for Reporting Preview Tab](images/TelerikReportingLastestPreview.png)
30-
3131
## Version Number Breakdown
3232

33-
The numbers in the name are determined by the source code build date. In other words, the version number corresponds to the date when the msi was built.
33+
The numbers in the name are determined by the build time of the source code.
3434

3535
The following image shows the name of the Preview generated on the 22nd of December (12th month), in the 2024 Q4 release sprint.
3636

37-
![Telerik Reporting Internal Build Version Number Breakdown](images/TelerikReportingVersionNumber.png)
38-
39-
## See Also
37+
![Telerik Reporting Internal Build Version Number Breakdown](images/TelerikReportingVersionNumber.png)
38+
39+
## See Also
40+
4041
* [Installation Approaches for Telerik Reporting]({%slug telerikreporting/installation%})
4142
* [Telerik Reporting Licensing]({%slug telerikreporting/licensing%})

getting-started/installation/installation-approaches.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ previous_url: /installation-system-requirements, /installation-installing-from-m
1111

1212
# Installation Approaches for Telerik Reporting
1313

14-
Telerik Reporting provides options for installing the product by [downloading the Control Panel](#downloading-the-control-panel), by [using the MSI installer file](#using-the-msi-file), or [with NuGet](#installing-with-nuget)(adds assemblies to the project, no design time support).
14+
Telerik Reporting provides options for installing the product by using [the Control Panel](#using-the-control-panel), by [the MSI installer file](#using-the-msi-file), or [NuGet](#installing-with-nuget). The NuGet packages add the Reporting assemblies to the project, but do not provide design time support.
1515

1616
>note After installing the product, you will need to [download and activate/update your Telerik Reporting License Key]({%slug license-key%}).
1717
18-
## Downloading the Control Panel
18+
## Using the Control Panel
1919

2020
You can install Telerik Reporting by downloading the Control Panel. For the complete instructions, refer to the [Progress Control Panel](https://docs.telerik.com/controlpanel/introduction) online documentation.
2121

@@ -89,29 +89,16 @@ To configure the Telerik NuGet Feed in Visual Studio:
8989
1. Enter a **Name** for the new package source, for example, **Telerik NuGet**.
9090
1. Add the `https://nuget.telerik.com/v3/index.json` URL as a **Source**. Make sure the URL does not have a trailing slash. Click **OK**.
9191

92-
### Handling Special Characters in Password
93-
94-
If your password contains a special character, those characters need to be escaped or it may fail authentication resulting in *Error 401 login failure* from the NuGet server. A common character that needs to be escaped is the ampersand `&`, but it can be as unique as the section character `§`. There are two ways to handle this.
95-
96-
1. Change the password so that it only includes characters that do not need to be escaped
97-
1. HTML encodes the password so the special characters are escaped (e.g. `my§uper&P@§§word` becomes `my§uper&P@§§word`).
98-
99-
We strongly discourage entering your password into an online encoder utility, use Powershell instead. Here's one example:
100-
101-
Add-Type -AssemblyName System.Web
102-
[System.Web.HttpUtility]::HtmlEncode('my§uper&P@§§word')
103-
104-
Result:
105-
106-
![Powershell Encoding of a Password containing special characters](images/PowerShellEncodingNugetPassword.png)
107-
10892
### Installing Telerik Reporting
10993

11094
After you have successfully added the Telerik NuGet feed as a package source, you need to authenticate your local NuGet instance and install Telerik Reporting:
11195

11296
1. Create a new Reporting project or open an existing one.
11397
1. Go to **Tools** > **NuGet Package Manager** > **Manage NuGet Packages for Solution...**. Select the Telerik NuGet **Package source** from the drop-down list on the left.
11498
1. Select the **Browse** tab to see the available packages. Enter your Telerik credentials in the Windows Authentication dialog.
99+
100+
> You may need to escape some [special characters in the password]({%slug telerikreporting/using-reports-in-applications/how-to-add-the-telerik-private-nuget-feed-to-visual-studio%}#handling-special-characters-in-password)
101+
115102
1. Select Telerik Reporting and click **Install**.
116103

117104
## See Also

report-items/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Every report item is an instance of the [`ReportItemBase`](/api/Telerik.Reportin
1717

1818
## Arranging Report Items
1919

20-
The report content is displayed in the report items. To use report items, select them from the **Toolbox** and place them on your report.
20+
The report's content is displayed in the report items. To use a report item, place it on your report.
2121

2222
### In Visual Studio
2323

0 commit comments

Comments
 (0)