Skip to content

Commit 4eb14ea

Browse files
authored
Adjust install content to put templates in front (#2786)
* Move template details a bit * Fix bookmarks
1 parent 411b24c commit 4eb14ea

File tree

4 files changed

+83
-81
lines changed

4 files changed

+83
-81
lines changed

docs/fundamentals/app-host-overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: .NET Aspire orchestration overview
33
description: Learn the fundamental concepts of .NET Aspire orchestration and explore the various APIs for adding resources and expressing dependencies.
4-
ms.date: 02/25/2025
4+
ms.date: 03/14/2025
55
ms.topic: overview
66
uid: dotnet/aspire/app-host
77
---
88

99
# .NET Aspire orchestration overview
1010

11-
.NET Aspire provides APIs for expressing resources and dependencies within your distributed application. In addition to these APIs, [there's tooling](setup-tooling.md#install-net-aspire) that enables several compelling scenarios. The orchestrator is intended for _local development_ purposes and isn't supported in production environments.
11+
.NET Aspire provides APIs for expressing resources and dependencies within your distributed application. In addition to these APIs, [there's tooling](setup-tooling.md#install-net-aspire-prerequisites) that enables several compelling scenarios. The orchestrator is intended for _local development_ purposes and isn't supported in production environments.
1212

1313
<span id="terminology"></span>
1414

docs/fundamentals/aspire-sdk-templates.md

+2-72
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: .NET Aspire templates
3-
description: Learn how to install the .NET Aspire templates, and how to use them to create new apps.
4-
ms.date: 11/09/2024
3+
description: Learn about the .NET Aspire templates and how to use them to create new apps.
4+
ms.date: 03/11/2025
55
zone_pivot_groups: dev-environment
66
uid: dotnet/aspire/templates
77
---
@@ -12,76 +12,6 @@ There are a number of .NET Aspire project templates available to you. You can us
1212

1313
The .NET Aspire templates are available in the [📦 Aspire.ProjectTemplates](https://www.nuget.org/packages/Aspire.ProjectTemplates) NuGet package.
1414

15-
## Install the .NET Aspire templates
16-
17-
:::zone pivot="visual-studio"
18-
19-
To install the .NET Aspire templates in Visual Studio, you need to manually install them unless you're using Visual Studio 17.12 or later. For Visual Studio 17.9 to 17.11, follow these steps:
20-
21-
1. Open Visual Studio.
22-
1. Go to **Tools** > **NuGet Package Manager** > **Package Manager Console**.
23-
1. Run the following command to install the templates:
24-
25-
```dotnetcli
26-
dotnet new install Aspire.ProjectTemplates
27-
```
28-
29-
For Visual Studio 17.12 or later, the .NET Aspire templates are installed automatically.
30-
31-
:::zone-end
32-
:::zone pivot="vscode,dotnet-cli"
33-
34-
To install these templates, use the [dotnet new install](/dotnet/core/tools/dotnet-new-install) command, passing in the `Aspire.ProjectTemplates` NuGet identifier.
35-
36-
```dotnetcli
37-
dotnet new install Aspire.ProjectTemplates
38-
```
39-
40-
To install a specific version, append the version number to the package name:
41-
42-
```dotnetcli
43-
dotnet new install Aspire.ProjectTemplates::9.0.0
44-
```
45-
46-
> [!TIP]
47-
> If you already have the .NET Aspire workload installed, you need to pass the `--force` flag to overwrite the existing templates. Feel free to uninstall the .NET Aspire workload.
48-
49-
:::zone-end
50-
51-
## List the .NET Aspire templates
52-
53-
:::zone pivot="visual-studio"
54-
55-
The .NET Aspire templates are installed automatically when you install Visual Studio 17.9 or later. To see what .NET Aspire templates are available, select **File** > **New** > **Project** in Visual Studio, and search for "Aspire" in the search bar (<kbd>Alt</kbd>+<kbd>S</kbd>). You'll see a list of available .NET Aspire project templates:
56-
57-
:::image type="content" source="media/vs-create-dotnet-aspire-proj.png" alt-text="Visual Studio: Create new project and search for 'Aspire'." lightbox="media/vs-create-dotnet-aspire-proj.png":::
58-
59-
:::zone-end
60-
:::zone pivot="vscode"
61-
62-
To view the available templates in Visual Studio Code with the C# DevKit installed, select the **Create .NET Project** button when no folder is opened in the **Explorer** view:
63-
64-
:::image type="content" source="media/vscode-create-dotnet-proj.png" alt-text="Visual Studio Code: Create .NET Project button." lightbox="media/vscode-create-dotnet-proj.png":::
65-
66-
Then, search for "Aspire" in the search bar to see the available .NET Aspire project templates:
67-
68-
:::image type="content" source="media/vscode-create-dotnet-aspire-proj.png" alt-text="Visual Studio Code: Create new project and search for 'Aspire'." lightbox="media/vscode-create-dotnet-aspire-proj.png":::
69-
70-
:::zone-end
71-
:::zone pivot="dotnet-cli"
72-
73-
To verify that the .NET Aspire templates are installed, use the [dotnet new list](/dotnet/core/tools/dotnet-new-list) command, passing in the `aspire` template name:
74-
75-
```dotnetcli
76-
dotnet new list aspire
77-
```
78-
79-
Your console output should look like the following:
80-
81-
[!INCLUDE [dotnet-new-list-aspire-output](includes/dotnet-new-list-aspire-output.md)]
82-
83-
:::zone-end
84-
8515
## Available templates
8616

8717
The .NET Aspire templates allow you to create new apps pre-configured with the .NET Aspire solutions structure and default settings. These projects also provide a unified debugging experience across the different resources of your app.

docs/fundamentals/setup-tooling.md

+78-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: .NET Aspire tooling
33
description: Learn about essential tooling concepts for .NET Aspire.
4-
ms.date: 02/24/2025
4+
ms.date: 03/11/2025
55
zone_pivot_groups: dev-environment
66
uid: dotnet/aspire/setup-tooling
77
---
@@ -17,7 +17,7 @@ uid: dotnet/aspire/setup-tooling
1717
> - Install .NET Aspire integrations
1818
> - Work with the .NET Aspire dashboard
1919
20-
## Install .NET Aspire
20+
## Install .NET Aspire prerequisites
2121

2222
To work with .NET Aspire, you need the following installed locally:
2323

@@ -58,6 +58,82 @@ To install the .NET Aspire workload in Visual Studio 2022, use the Visual Studio
5858

5959
:::zone-end
6060

61+
## .NET Aspire templates
62+
63+
.NET Aspire provides a set of solution and project templates. These templates are available in your favorite .NET developer integrated environment. You can use these templates to create full .NET Aspire solutions, or add individual projects to existing .NET Aspire solutions.
64+
65+
### Install the .NET Aspire templates
66+
67+
:::zone pivot="visual-studio"
68+
69+
To install the .NET Aspire templates in Visual Studio, you need to manually install them unless you're using Visual Studio 17.12 or later. For Visual Studio 17.9 to 17.11, follow these steps:
70+
71+
1. Open Visual Studio.
72+
1. Go to **Tools** > **NuGet Package Manager** > **Package Manager Console**.
73+
1. Run the following command to install the templates:
74+
75+
```dotnetcli
76+
dotnet new install Aspire.ProjectTemplates
77+
```
78+
79+
For Visual Studio 17.12 or later, the .NET Aspire templates are installed automatically.
80+
81+
:::zone-end
82+
:::zone pivot="vscode,dotnet-cli"
83+
84+
To install these templates, use the [dotnet new install](/dotnet/core/tools/dotnet-new-install) command, passing in the `Aspire.ProjectTemplates` NuGet identifier.
85+
86+
```dotnetcli
87+
dotnet new install Aspire.ProjectTemplates
88+
```
89+
90+
To install a specific version, append the version number to the package name:
91+
92+
```dotnetcli
93+
dotnet new install Aspire.ProjectTemplates::9.0.0
94+
```
95+
96+
> [!TIP]
97+
> If you already have the .NET Aspire workload installed, you need to pass the `--force` flag to overwrite the existing templates. Feel free to uninstall the .NET Aspire workload.
98+
99+
:::zone-end
100+
101+
### List the .NET Aspire templates
102+
103+
:::zone pivot="visual-studio"
104+
105+
The .NET Aspire templates are installed automatically when you install Visual Studio 17.9 or later. To see what .NET Aspire templates are available, select **File** > **New** > **Project** in Visual Studio, and search for "Aspire" in the search bar (<kbd>Alt</kbd>+<kbd>S</kbd>). You'll see a list of available .NET Aspire project templates:
106+
107+
:::image type="content" source="media/vs-create-dotnet-aspire-proj.png" alt-text="Visual Studio: Create new project and search for 'Aspire'." lightbox="media/vs-create-dotnet-aspire-proj.png":::
108+
109+
:::zone-end
110+
:::zone pivot="vscode"
111+
112+
To view the available templates in Visual Studio Code with the C# DevKit installed, select the **Create .NET Project** button when no folder is opened in the **Explorer** view:
113+
114+
:::image type="content" source="media/vscode-create-dotnet-proj.png" alt-text="Visual Studio Code: Create .NET Project button." lightbox="media/vscode-create-dotnet-proj.png":::
115+
116+
Then, search for "Aspire" in the search bar to see the available .NET Aspire project templates:
117+
118+
:::image type="content" source="media/vscode-create-dotnet-aspire-proj.png" alt-text="Visual Studio Code: Create new project and search for 'Aspire'." lightbox="media/vscode-create-dotnet-aspire-proj.png":::
119+
120+
:::zone-end
121+
:::zone pivot="dotnet-cli"
122+
123+
To verify that the .NET Aspire templates are installed, use the [dotnet new list](/dotnet/core/tools/dotnet-new-list) command, passing in the `aspire` template name:
124+
125+
```dotnetcli
126+
dotnet new list aspire
127+
```
128+
129+
Your console output should look like the following:
130+
131+
[!INCLUDE [dotnet-new-list-aspire-output](includes/dotnet-new-list-aspire-output.md)]
132+
133+
:::zone-end
134+
135+
For more information, see [.NET Aspire templates](aspire-sdk-templates.md).
136+
61137
## Container runtime
62138

63139
.NET Aspire projects are designed to run in containers. You can use either Docker Desktop or Podman as your container runtime. [Docker Desktop](https://www.docker.com/products/docker-desktop/) is the most common container runtime. [Podman](https://podman.io/docs/installation) is an open-source daemonless alternative to Docker, that can build and run Open Container Initiative (OCI) containers. If your host environment has both Docker and Podman installed, .NET Aspire defaults to using Docker. You can instruct .NET Aspire to use Podman instead, by setting the `DOTNET_ASPIRE_CONTAINER_RUNTIME` environment variable to `podman`:
@@ -80,10 +156,6 @@ For more information, see [Install Podman on Windows](https://podman.io/docs/ins
80156

81157
---
82158

83-
## .NET Aspire templates
84-
85-
.NET Aspire provides a set of solution and project templates. These templates are available in your favorite .NET developer integrated environment. You can use these templates to create full .NET Aspire solutions, or add individual projects to existing .NET Aspire solutions. For more information, see [.NET Aspire templates](aspire-sdk-templates.md).
86-
87159
## .NET Aspire dashboard
88160

89161
.NET Aspire templates that expose the [app host](app-host-overview.md) project also include a useful developer [dashboard](dashboard/overview.md) that's used to monitor and inspect various aspects of your app, such as logs, traces, and environment configurations. This dashboard is designed to improve the local development experience and provides an overview of the overall state and structure of your app.

docs/includes/dotnet-cli-file-new.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you haven't already installed the [.NET Aspire templates](../fundamentals/aspire-sdk-templates.md#install-the-net-aspire-templates), run the following `dotnet new install` command:
1+
If you haven't already installed the [.NET Aspire templates](../fundamentals/setup-tooling.md#install-the-net-aspire-templates), run the following `dotnet new install` command:
22

33
```dotnetcli
44
dotnet new install Aspire.ProjectTemplates

0 commit comments

Comments
 (0)