Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix 2.1 docs #2367

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Fix 2.1 docs #2367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4a74f1
Fix broken link in getting started
benjaminpetit Jan 3, 2024
d138075
Update doc to use dotnet 8 and reference yarp 2.1
benjaminpetit Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/docfx/articles/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,19 @@ We plan on providing a project template and pre-built exe in the future.
YARP is implemented on top of .NET Core infrastructure and is usable on Windows, Linux or MacOS.
Development can be done with the SDK and your favorite editor, [Microsoft Visual Studio](https://visualstudio.microsoft.com/vs/) or [Visual Studio Code](https://code.visualstudio.com/).

YARP 2.0.0 supports ASP.NET Core 6.0 and newer.
YARP 2.1.0 supports ASP.NET Core 6.0 and newer, including ASP.NET Core 8.0.
You can download the .NET SDK from https://dotnet.microsoft.com/download/dotnet/.

Visual Studio support for .NET 6 is included in Visual Studio 2022.
Visual Studio support for .NET 8 is included in Visual Studio 2022 17.8.

### Create a new project

A complete version of the project built using the steps below can be found at [Minimal YARP Sample](https://github.com/microsoft/reverse-proxy/tree/release/latest/samples/ReverseProxy.Minimal.Sample).
For a version that does not use [top-level statements](https://docs.microsoft.com/dotnet/csharp/fundamentals/program-structure/top-level-statements), see the [Basic YARP Sample](https://github.com/microsoft/reverse-proxy/tree/release/latest/samples/BasicYarpSample).
A complete version of the project built using the steps below can be found at [Basic YARP Sample](https://github.com/microsoft/reverse-proxy/tree/release/latest/samples/BasicYarpSample).

Start by creating an "Empty" ASP.NET Core application using the command line:

```Console
dotnet new web -n MyProxy -f net6.0
dotnet new web -n MyProxy -f net8.0
```

Or create a new ASP.NET Core web application in Visual Studio 2022, and choose "Empty" for the project template.
Expand All @@ -34,7 +33,7 @@ Or create a new ASP.NET Core web application in Visual Studio 2022, and choose "

```XML
<ItemGroup>
<PackageReference Include="Yarp.ReverseProxy" Version="1.1.0-rc.2.22152.2" />
<PackageReference Include="Yarp.ReverseProxy" Version="2.1.0" />
</ItemGroup>
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docfx/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- name: About YARP 2.0
- name: About YARP 2.1
href: index.md
- name: Articles
href: articles/
Expand Down