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

Jump to bottom

Added more cross linking between tooling and comps, also add more det… #121

Merged
merged 6 commits into from
Dec 4, 2023
Merged

Added more cross linking between tooling and comps, also add more det… #121

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6a08775
Added more cross linking between tooling and comps, also add more det…
IEvangelist Dec 4, 2023
f5df990
Update docs/components-overview.md
IEvangelist Dec 4, 2023
0cfd436
Added more images of VS, show prerelease checkbox, and context menu
IEvangelist Dec 4, 2023
8c98411
Fix image, remove highlight
IEvangelist Dec 4, 2023
d362809
Add more supporting images for context menus
IEvangelist Dec 4, 2023
527145b
Fix lightbox image name
IEvangelist Dec 4, 2023
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
4 changes: 3 additions & 1 deletion docs/components-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: .NET Aspire components overview
description: Explore the fundamental concepts of .NET Aspire components and learn how to integrate them into your apps.
ms.date: 11/15/2023
ms.date: 12/03/2023
ms.topic: conceptual
---

# .NET Aspire components overview

.NET Aspire components are a curated suite of NuGet packages specifically selected to facilitate the integration of cloud-native applications with prominent services and platforms, including but not limited to Redis and PostgreSQL. Each component furnishes essential cloud-native functionalities through either automatic provisioning or standardized configuration patterns.

For more information on Visual Studio tooling support, see [Visual Studio tooling](setup-tooling.md#visual-studio-tooling).
IEvangelist marked this conversation as resolved.
Show resolved Hide resolved

## Available components

The following table lists the .NET Aspire components currently available for use:
Expand Down
10 changes: 7 additions & 3 deletions docs/setup-tooling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire tooling
description: Learn about essential tooling concepts for .NET Aspire.
ms.date: 12/01/2023
ms.date: 12/03/2023
---

# .NET Aspire setup and tooling
Expand Down Expand Up @@ -135,19 +135,21 @@ Visual Studio provides additional features for working with .NET Aspire componen

### Enable .NET Aspire preview support

In Visual Studio, you can enable preview support for .NET Aspire components and project templates. To enable preview support, select **Tools** > **Options** > and in the **Search Settings** textbox enter "aspire", then ensure that the **Enable .NET Aspire preview support** is checked:
In Visual Studio, you can enable preview support for .NET Aspire components and project templates. To enable preview support, select **Tools** > **Options** > and in the **Search Settings** textbox enter "aspire", then ensure that the **Enable support for .NET Aspire** is checked:

:::image type="content" source="media/visual-studio-tools-options-aspire.png" lightbox="media/visual-studio-tools-options-aspire.png" alt-text="Visual Studio 2022, enable .NET Aspire preview support.":::

Likewise, you can disable preview support by unchecking the **Enable .NET Aspire preview support** option.

### Add a component

You can add .NET Aspire components to your app like any other NuGet package using Visual Studio. However, Visual Studio also provides UI options to add .NET Aspire components directly.
You add .NET Aspire components to your app like any other NuGet package using Visual Studio. However, Visual Studio also provides UI options to add .NET Aspire components directly. You need to first enable preview support for .NET Aspire components in Visual Studio. For information see, [Enable .NET Aspire preview support](#enable-net-aspire-preview-support).
IEvangelist marked this conversation as resolved.
Show resolved Hide resolved

1. In Visual Studio, right click on the project you want to add an .NET Aspire component to and select **Add** > **.NET Aspire Component...**.
1. The package manager will open with search results pre-configured for .NET Aspire components, allowing you to easily browse and select the desired component.

For more information on .NET Aspire components, see [.NET Aspire components overview](components-overview.md).

### Add orchestration projects

You can add .NET Aspire orchestration projects to an existing app using the following steps:
Expand All @@ -163,6 +165,8 @@ You can add .NET Aspire orchestration projects to an existing app using the foll
- A call to `builder.AddServiceDefaults` will be added to the _Program.cs_ file of your original project.
- A reference to your original project will be added to the _Program.cs_ file of the **.AppHost** project.

For more information on .NET Aspire orchestration, see [.NET Aspire orchestration overview](app-host-overview.md).

### Enlist in orchestration

Visual Studio provides the option to **Enlist in Aspire orchestration** during the new project workflow. Select this option to have Visual Studio create **.AppHost** and **.ServiceDefault** projects alongside your selected project template.
Expand Down
Loading