Skip to content

✅ Merge main into live #940

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.

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

Merged
merged 1 commit into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 11 additions & 0 deletions assets/dotnet-aspire-logo-128.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions assets/dotnet-aspire-logo-256.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions assets/dotnet-aspire-logo-32.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions assets/dotnet-aspire-logo-48.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions assets/dotnet-aspire-logo-64.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 76 additions & 4 deletions docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"dest": ".",
"exclude": [
"**/obj/**",
"**/includes/**",
"**/includes/**.md",
"_themes/**",
"_themes.pdf/**",
"**/docfx.json",
Expand All @@ -43,10 +43,10 @@
"**/*.png",
"**/*.svg",
"**/zone-pivot-groups.json"
],
],
"exclude": [
"**/obj/**",
"**/includes/**",
"**/includes/**.md",
"_themes/**",
"_themes.pdf/**",
"**/docfx.json",
Expand Down Expand Up @@ -110,9 +110,81 @@
},
"titleSuffix": {
"docs/**/**.md": ".NET Aspire"
},
"no-loc": {
"**/**.md": [
".NET Aspire",
".NET",
"Angular",
"Apache Kafka",
"Application Insights",
"ASP.NET Core",
"ASP.NET",
"Aspire",
"Azure AI OpenAI",
"Azure Blob Storage",
"Azure Cache for Redis",
"Azure Container Apps",
"Azure Cosmos DB",
"Azure Developer CLI",
"Azure Event Hubs",
"Azure Key Vault",
"Azure Search Documents",
"Azure Service Bus",
"Azure SignalR Service",
"Azure Storage Queues",
"Azure Table Storage",
"Azure",
"Blazor WebAssembly",
"Blazor",
"C# Dev Kit",
"Client",
"Cookie",
"cookie",
"Cosmos DB",
"Dapr",
"Docker",
"Dockerfile",
"EF Core",
"Entity Framework Core",
"Git",
"GitHub",
"JSON",
"Kubernetes",
"Linux",
"localhost",
"MailDev",
"MongoDB",
"MySQL",
"NATS",
"Node.js",
"OpenAI",
"OpenAPI",
"OpenTelemetry",
"Oracle",
"Orleans",
"Podman",
"Postgres",
"PostgreSQL",
"Privacy",
"RabbitMQ",
"React",
"Redis",
"REST",
"Seq",
"Server",
"SignalR",
"SQL Server",
"Unix",
"Visual Studio Code",
"Visual Studio",
"Vue",
"WASM",
"Worker Service"
]
}
},
"template": [],
"dest": "dotnet-aspire-docs"
}
}
}
12 changes: 6 additions & 6 deletions docs/azureai/azureai-openai-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: .NET Aspire Azure AI OpenAI component
description: Learn how to use the .NET Aspire Azure AI OpenAI component.
ms.topic: how-to
ms.date: 04/24/2024
ms.date: 05/14/2024
---

# .NET Aspire Azure AI OpenAI component
Expand All @@ -21,7 +21,7 @@ To get started with the .NET Aspire Azure AI OpenAI component, install the [Aspi
### [.NET CLI](#tab/dotnet-cli)

```dotnetcli
dotnet add package Aspire.Azure.AI.OpenAI --prerelease
dotnet add package Aspire.Azure.AI.OpenAI
```

### [PackageReference](#tab/package-reference)
Expand All @@ -37,7 +37,7 @@ For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-pac

## Example usage

In the _Program.cs_ file of your component-consuming project, call the extension method to register an `OpenAIClient` for use via the dependency injection container. The method takes a connection name parameter.
In the _:::no-loc text="Program.cs":::_ file of your component-consuming project, call the extension method to register an `OpenAIClient` for use via the dependency injection container. The method takes a connection name parameter.

```csharp
builder.AddAzureOpenAIClient("openAiConnectionName");
Expand All @@ -59,7 +59,7 @@ To add Azure AI hosting support to your <xref:Aspire.Hosting.IDistributedApplica
### [.NET CLI](#tab/dotnet-cli)

```dotnetcli
dotnet add package Aspire.Hosting.Azure.CognitiveServices --prerelease
dotnet add package Aspire.Hosting.Azure.CognitiveServices
```

### [PackageReference](#tab/package-reference)
Expand All @@ -84,7 +84,7 @@ builder.AddProject<Projects.ExampleProject>()
.WithReference(openai);
```

The `AddAzureAIOpenAI` method will read connection information from the app host's configuration (for example, from "user secrets") under the `ConnectionStrings:openAiConnectionName` config key. The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method passes that connection information into a connection string named `openAiConnectionName` in the `ExampleProject` project. In the _Program.cs_ file of ExampleProject, the connection can be consumed using:
The `AddAzureAIOpenAI` method will read connection information from the app host's configuration (for example, from "user secrets") under the `ConnectionStrings:openAiConnectionName` config key. The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method passes that connection information into a connection string named `openAiConnectionName` in the `ExampleProject` project. In the _:::no-loc text="Program.cs":::_ file of ExampleProject, the connection can be consumed using:

```csharp
builder.AddAzureAIOpenAI("openAiConnectionName");
Expand Down Expand Up @@ -132,7 +132,7 @@ In order to connect to the non-Azure OpenAI service, drop the `Endpoint` propert

### Use configuration providers

The .NET Aspire Azure AI OpenAI component supports <xref:Microsoft.Extensions.Configuration>. It loads the `AzureOpenAISettings` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example `appsettings.json` that configures some of the options:
The .NET Aspire Azure AI OpenAI component supports <xref:Microsoft.Extensions.Configuration>. It loads the `AzureOpenAISettings` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example _:::no-loc text="appsettings.json":::_ that configures some of the options:

```json
{
Expand Down
14 changes: 7 additions & 7 deletions docs/azureai/azureai-search-document-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: .NET Aspire Azure AI Search Documents component
description: Learn how to use the .NET Aspire Azure AI Search Documents component.
ms.topic: how-to
ms.date: 04/18/2024
ms.date: 05/14/2024
---

# .NET Aspire Azure AI Search Documents component
Expand All @@ -21,7 +21,7 @@ To get started with the .NET Aspire Azure AI Search Documents component, install
### [.NET CLI](#tab/dotnet-cli)

```dotnetcli
dotnet add package Aspire.Azure.Search.Documents --prerelease
dotnet add package Aspire.Azure.Search.Documents
```

### [PackageReference](#tab/package-reference)
Expand All @@ -37,7 +37,7 @@ For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-pac

## Example usage

In the _Program.cs_ file of your component-consuming project, call the extension method to register an `SearchIndexClient` for use via the dependency injection container. The method takes a connection name parameter.
In the _:::no-loc text="Program.cs":::_ file of your component-consuming project, call the extension method to register an `SearchIndexClient` for use via the dependency injection container. The method takes a connection name parameter.

```csharp
builder.AddAzureSearch("searchConnectionName");
Expand Down Expand Up @@ -80,7 +80,7 @@ To add Azure AI hosting support to your <xref:Aspire.Hosting.IDistributedApplica
### [.NET CLI](#tab/dotnet-cli)

```dotnetcli
dotnet add package Aspire.Hosting.Azure.CognitiveServices --prerelease
dotnet add package Aspire.Hosting.Azure.CognitiveServices
```

### [PackageReference](#tab/package-reference)
Expand All @@ -92,7 +92,7 @@ dotnet add package Aspire.Hosting.Azure.CognitiveServices --prerelease

---

In the _Program.cs_ file of `AppHost`, add an Azure Search service and consume the connection using the following methods:
In the _:::no-loc text="Program.cs":::_ file of `AppHost`, add an Azure Search service and consume the connection using the following methods:

```csharp
var search = builder.ExecutionContext.IsPublishMode
Expand All @@ -103,7 +103,7 @@ var myService = builder.AddProject<Projects.MyService>()
.WithReference(search);
```

The `AddAzureSearch` method will read connection information from the AppHost's configuration (for example, from "user secrets") under the `ConnectionStrings:search` config key. The `WithReference` method passes that connection information into a connection string named `search` in the `MyService` project. In the _Program.cs_ file of `MyService`, the connection can be consumed using:
The `AddAzureSearch` method will read connection information from the AppHost's configuration (for example, from "user secrets") under the `ConnectionStrings:search` config key. The `WithReference` method passes that connection information into a connection string named `search` in the `MyService` project. In the _:::no-loc text="Program.cs":::_ file of `MyService`, the connection can be consumed using:

```csharp
builder.AddAzureSearch("search");
Expand Down Expand Up @@ -149,7 +149,7 @@ Alternatively, a custom connection string can be used.

### Use configuration providers

The .NET Aspire Azure AI Search library supports <xref:Microsoft.Extensions.Configuration?displayProperty=fullName>. It loads the `AzureSearchSettings` and `SearchClientOptions` from configuration by using the `Aspire:Azure:Search:Documents` key. Example `appsettings.json` that configures some of the options:
The .NET Aspire Azure AI Search library supports <xref:Microsoft.Extensions.Configuration?displayProperty=fullName>. It loads the `AzureSearchSettings` and `SearchClientOptions` from configuration by using the `Aspire:Azure:Search:Documents` key. Example _:::no-loc text="appsettings.json":::_ that configures some of the options:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/breadcrumb/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ items:
tocHref: /dotnet/
topicHref: /dotnet/index
items:
- name: .NET Aspire (Preview)
- name: .NET Aspire
tocHref: /dotnet/aspire/
topicHref: /dotnet/aspire/index
items:
Expand Down
Loading
Loading