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.

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 broken links #88

Merged
merged 2 commits into from
Nov 27, 2023
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
10 changes: 5 additions & 5 deletions docs/caching/quickstart-caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Visual Studio creates a new .NET Aspire solution that consists of the following

## Configure the UI with output caching

1. Add the [.NET Aspire StackExchange Redis output caching](/aspire/caching/stackexchange-redis-output-caching-component) component packages to your `AspireStorage` app:
1. Add the [.NET Aspire StackExchange Redis output caching](stackexchange-redis-output-caching-component.md) component packages to your `AspireStorage` app:

```dotnetcli
dotnet add package Aspire.StackExchange.Redis.OutputCaching --prerelease
Expand Down Expand Up @@ -73,19 +73,19 @@ dotnet add package Aspire.StackExchange.Redis.OutputCaching --prerelease
```razor
@page "/"
@attribute [OutputCache(Duration = 10)]

<PageTitle>Home</PageTitle>

<h1>Hello, world!</h1>

Welcome to your new app on @DateTime.Now
```

The component include the `[OutputCache]` attribute, which caches the entire rendered response. The page also include a call to `@DateTime.Now` to help verify that the response is cached.

## Configure the API with distributed caching

1. Add the [.NET Aspire StackExchange Redis distributed caching](/aspire/caching/stackexchange-redis-distributed-caching-component) component packages to your `AspireRedis` app:
1. Add the [.NET Aspire StackExchange Redis distributed caching](stackexchange-redis-output-caching-component.md) component packages to your `AspireRedis` app:

```dotnetcli
dotnet add package Aspire.StackExchange.Redis.DistributedCaching --prerelease
Expand Down
6 changes: 3 additions & 3 deletions docs/caching/stackexchange-redis-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.StackExchange.Redis --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -107,10 +107,10 @@ builder.AddRedis(
In your orchestrator project, register the .NET Aspire Stack Exchange Redis component and consume the service using the following methods:

```csharp
// Service registration
// Service registration
var redis = builder.AddRedisContainer("redis");

// Service consumption
// Service consumption
builder.AddProject<Projects.ExampleProject>()
.WithReference(redis)
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.StackExchange.Redis.DistributedCaching --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -106,7 +106,7 @@ You can also set up the [ConfigurationOptions](https://stackexchange.github.io/S

```csharp
builder.AddRedisDistributedCache(
"cache",
"cache",
configureOptions: options => options.ConnectTimeout = 3000);
```

Expand All @@ -115,10 +115,10 @@ builder.AddRedisDistributedCache(
In your orchestrator project, register the .NET Aspire Stack Exchange Redis component and consume the service using the following methods, such as <xref:Aspire.Hosting.RedisBuilderExtensions.AddRedisContainer%2A>:

```csharp
// Service registration
// Service registration
var redis = builder.AddRedisContainer("redis");

// Service consumption
// Service consumption
builder.AddProject<Projects.ExampleProject>()
.WithReference(redis)
```
Expand Down
12 changes: 6 additions & 6 deletions docs/caching/stackexchange-redis-output-caching-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ ms.date: 11/15/2023

# .NET Aspire StackExchange Redis output caching component

In this article, you learn how to use the .NET Aspire StackExchange Redis output caching component. The `Aspire.StackExchange.Redis.OutputCaching` library is used to register an [ASP.NET Core Output Caching](/aspnet/core/performance/caching/output) provider backed by a [Redis](https://redis.io/) server. It enables corresponding health check, logging and telemetry.
In this article, you learn how to use the .NET Aspire StackExchange Redis output caching component. The `Aspire.StackExchange.Redis.OutputCaching` library is used to register an [ASP.NET Core Output Caching](/aspnet/core/performance/caching/output) provider backed by a [Redis](https://redis.io/) server. It enables corresponding health check, logging, and telemetry.

## Get started

To get started with the .NET Aspire StackExchange Redis output caching component, install the [Aspire.StackExchange.Redis.OutputCache](https://www.nuget.org/packages/Aspire.StackExchange.Redis.OutputCache) NuGet package.
To get started with the .NET Aspire StackExchange Redis output caching component, install the [Aspire.StackExchange.Redis.OutputCaching](https://www.nuget.org/packages/Aspire.StackExchange.Redis.OutputCaching) NuGet package.

### [.NET CLI](#tab/dotnet-cli)

Expand All @@ -28,7 +28,7 @@ dotnet add package Aspire.StackExchange.Redis.OutputCaching

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -114,7 +114,7 @@ You can also set up the [ConfigurationOptions](https://stackexchange.github.io/S

```csharp
builder.AddRedisOutputCache(
"cache",
"cache",
configureOptions: options => options.ConnectTimeout = 3000);
```

Expand All @@ -123,10 +123,10 @@ builder.AddRedisOutputCache(
In your orchestrator project, register the .NET Aspire StackExchange Redis output caching component and consume the service using the following methods:

```csharp
// Service registration
// Service registration
var redis = builder.AddRedisContainer("redis");

// Service consumption
// Service consumption
var basket = builder.AddProject<Projects.ExampleProject>()
.WithReference(redis)
```
Expand Down
6 changes: 3 additions & 3 deletions docs/components-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The following table lists the .NET Aspire components currently available for use

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

1. In the _Program.cs_ file of your project, call the <xref:Microsoft.Extensions.Hosting.AspirePostgreSqlNpgsqlExtensions.AddNpgsqlDataSource%2A> extension method to register a `NpgsqlDataSource` for use via the dependency injection container. The method expects a connection name parameter.

Expand Down Expand Up @@ -118,7 +118,7 @@ public class ExampleService(NpgsqlDataSource dataSource)
}
```

For more information, see [.NET dependency injection](/dotnet/core/extensions/dependency-injection.md).
For more information, see [.NET dependency injection](/dotnet/core/extensions/dependency-injection).

### Keyed services

Expand Down Expand Up @@ -186,4 +186,4 @@ If either of these operations fail, the health check also fails. For more inform

- **Timeouts**: You can configure how long an .NET Aspire component waits for a request to finish before it times out. Timeout configurations can be useful for handling dependencies with variable response times.

For more information, see [Build resilient HTTP apps](/dotnet/core/resilience/http-resilience.md).
For more information, see [Build resilient HTTP apps](/dotnet/core/resilience/http-resilience).
2 changes: 1 addition & 1 deletion docs/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Consider the following example screenshot of the metrics page, with the `webfron

:::image type="content" source="media/dashboard/metrics-view.png" lightbox="media/dashboard/metrics-view.png" alt-text="A screenshot of the .NET Aspire dashboard Metrics page.":::

For more information about metrics, see [Built-in Metrics in .NET](/dotnet/core/diagnostics/built-in-metrics.md).
For more information about metrics, see [Built-in Metrics in .NET](/dotnet/core/diagnostics/built-in-metrics).

## Theme selection

Expand Down
4 changes: 2 additions & 2 deletions docs/database/azure-cosmos-db-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Microsoft.Azure.Cosmos --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -133,7 +133,7 @@ builder.AddAzureCosmosDB(
In your orchestrator project, register the .NET Aspire Azure Cosmos DB component and consume the service using the following methods:

```csharp
// Service registration
// Service registration
var cosmosdb = builder.AddAzureCosmosDB("cdb")
.AddDatabase("cosmosdb");

Expand Down
4 changes: 2 additions & 2 deletions docs/database/azure-cosmos-db-entity-framework-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Microsoft.EntityFrameworkCore.Cosmos --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -107,7 +107,7 @@ builder.AddCosmosDbContext<MyDbContext>(
In your orchestrator project, register the .NET Aspire Microsoft Entity Framework Core Cosmos DB component and consume the service using the following methods:

```csharp
// Service registration
// Service registration
var cosmosdbService = builder.AddAzureCosmosDB("cdb")
.AddDatabase("cosmosdb");

Expand Down
2 changes: 1 addition & 1 deletion docs/database/postgresql-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Npgsql --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
2 changes: 1 addition & 1 deletion docs/database/postgresql-entity-framework-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ dotnet add package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
2 changes: 1 addition & 1 deletion docs/database/sql-server-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ dotnet add package Aspire.Microsoft.Data.SqlClient --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
2 changes: 1 addition & 1 deletion docs/database/sql-server-entity-framework-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ dotnet add package Aspire.Microsoft.EntityFrameworkCore.SqlServer --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/manifest-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ dotnet run --project AspireApp.AppHost\AspireApp.AppHost.csproj `
--output-path aspire-manifest.json
```

For more information, see [dotnet build](/dotnet/core/tools/dotnet-build.md). The previous command produces the following output:
For more information, see [dotnet build](/dotnet/core/tools/dotnet-build). The previous command produces the following output:

```Output
Building...
Expand Down
6 changes: 3 additions & 3 deletions docs/get-started/quickstart-build-your-first-aspire-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Consider the _Program.cs_ file of the _AspireSample.AppHost_ project:

:::code source="snippets/quickstart/AspireSample/AspireSample.AppHost/Program.cs":::

If you've used either the [.NET Generic Host](/dotnet/core/extensions/generic-host.md) or the [ASP.NET Core Web Host](/aspnet/core/fundamentals/host/web-host) before, the app host programming model and builder pattern should be familiar to you. The preceding code:
If you've used either the [.NET Generic Host](/dotnet/core/extensions/generic-host) or the [ASP.NET Core Web Host](/aspnet/core/fundamentals/host/web-host) before, the app host programming model and builder pattern should be familiar to you. The preceding code:

- Creates an <xref:Aspire.Hosting.IDistributedApplicationBuilder> instance from calling <xref:Aspire.Hosting.DistributedApplication.CreateBuilder?displayProperty=nameWithType>.
- Calls <xref:Aspire.Hosting.RedisBuilderExtensions.AddRedisContainer%2A> with the name `"cache"` to add a Redis container to the app, assigning the returned value to a variable named `cache`, which is of type `IResourceBuilder<RedisContainerResource>`.
Expand Down Expand Up @@ -85,7 +85,7 @@ The preceding code:
- Calls <xref:Microsoft.Extensions.Hosting.AspireRedisOutputCacheExtensions.AddRedisOutputCache%2A> with the same `connectionName` that was used when adding the Redis container `"cache"` to the application model. This configures the app to use Redis for output caching.
- Calls <xref:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient%2A> and configures the <xref:System.Net.Http.HttpClient.BaseAddress?displayProperty=nameWithType> to be `"http://apiservice"`. This is the name that was used when adding the API project to the application model, and with service discovery configured, it will automatically resolve to the correct address to the API project.

For more information, see [Make HTTP requests with the `HttpClient`](/dotnet/fundamentals/networking/http/httpclient.md) class.
For more information, see [Make HTTP requests with the `HttpClient`](/dotnet/fundamentals/networking/http/httpclient) class.

## Test the app locally

Expand All @@ -104,7 +104,7 @@ In Visual Studio, set the **AspireSample.AppHost** project as the startup projec
dotnet run --project AspireSample/AspireSample.AppHost
```

For more information, see [dotnet run](/dotnet/core/tools/dotnet-run.md).
For more information, see [dotnet run](/dotnet/core/tools/dotnet-run).

---

Expand Down
2 changes: 1 addition & 1 deletion docs/includes/file-new-aspire.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Visual Studio creates a new solution that is structured to use .NET Aspire.
dotnet new aspire-starter --use-redis-cache --output AspireSample
```

For more information, see [dotnet new](/dotnet/core/tools/dotnet-new.md). The .NET CLI creates a new solution that is structured to use .NET Aspire.
For more information, see [dotnet new](/dotnet/core/tools/dotnet-new). The .NET CLI creates a new solution that is structured to use .NET Aspire.

---
2 changes: 1 addition & 1 deletion docs/messaging/azure-service-bus-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ dotnet add package Aspire.Azure.Messaging.ServiceBus --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
8 changes: 4 additions & 4 deletions docs/messaging/quickstart-messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The completed solution structure should resemble the following:

## Add the .NET Aspire component to the API

Add the [.NET Aspire Azure Service Bus](/aspire/messaging/aspire-azure-service-bus) component to your `AspireMessaging` app:
Add the [.NET Aspire Azure Service Bus](azure-service-bus-component.md) component to your `AspireMessaging` app:

```dotnetcli
dotnet add package Aspire.Azure.Messaging.ServiceBus --prerelease
Expand Down Expand Up @@ -170,7 +170,7 @@ app.MapPost("/notify", static async (ServiceBusClient client, string message) =>
$"The message {message} is too large to fit in the batch.");
}

// Use the producer client to send the batch of
// Use the producer client to send the batch of
// messages to the Service Bus topic.
await sender.SendMessagesAsync(messageBatch);

Expand All @@ -180,7 +180,7 @@ app.MapPost("/notify", static async (ServiceBusClient client, string message) =>

## Add the .NET Aspire component to the Worker Service

Add the [.NET Aspire Azure Service Bus](/aspire/messaging/aspire-azure-service-bus) component to your `AspireMessaging.Worker` app:
Add the [.NET Aspire Azure Service Bus](azure-service-bus-component.md) component to your `AspireMessaging.Worker` app:

```dotnetcli
dotnet add package Aspire.Azure.Messaging.ServiceBus --prerelease
Expand Down Expand Up @@ -249,7 +249,7 @@ public class Worker(
// add handler to process any errors
processor.ProcessErrorAsync += ErrorHandler;

// start processing
// start processing
await processor.StartProcessingAsync();

logger.LogInformation(
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging/rabbitmq-client-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.RabbitMQ.Client --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
2 changes: 1 addition & 1 deletion docs/security/azure-security-key-vault-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Azure.Security.KeyVault --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down
4 changes: 2 additions & 2 deletions docs/service-discovery/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,5 +125,5 @@ builder.Services.AddHttpClient<BasketServiceDashboardClient>(
## See also

- [Service discovery in .NET](/dotnet/core/extensions/service-discovery)
- [Make HTTP requests with the HttpClient class](/dotnet/fundamentals/networking/http/httpclient.md)
- [IHttpClientFactory with .NET](/dotnet/core/extensions/httpclient-factory.md)
- [Make HTTP requests with the HttpClient class](/dotnet/fundamentals/networking/http/httpclient)
- [IHttpClientFactory with .NET](/dotnet/core/extensions/httpclient-factory)
2 changes: 1 addition & 1 deletion docs/setup-tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To install the .NET Aspire workload in Visual Studio 2022 Preview, use the Visua

# [.NET CLI](#tab/dotnet-cli)

To install the .NET Aspire workload from the .NET CLI, use the [dotnet workload install](/dotnet-internal/core/tools/dotnet-workload-install) command:
To install the .NET Aspire workload from the .NET CLI, use the [dotnet workload install](/dotnet/core/tools/dotnet-workload-install) command:

```dotnetcli
dotnet workload install aspire
Expand Down
4 changes: 2 additions & 2 deletions docs/storage/azure-storage-blobs-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Azure.Storage.Blobs --prerelease

---

For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package.md) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies.md).
For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage

Expand Down Expand Up @@ -124,7 +124,7 @@ You can also set up the `BlobClientOptions` using `Action<IAzureClientBuilder<Bl
```csharp
builder.AddAzureBlobService(
"blobs",
configureClientBuilder: clientBuilder =>
configureClientBuilder: clientBuilder =>
clientBuilder.ConfigureOptions(options => options.Diagnostics.ApplicationId = "myapp"));
```

Expand Down
Loading
Loading