Skip to content

Commit 6485cd6

Browse files
IEvangelistCopilot
andauthored
Migration 3 of several (#5810)
* Update documentation links to point to the new Aspire.dev URLs and remove obsolete service discovery documentation - Updated links in various documentation files to direct users to the new Aspire.dev URLs for service discovery, service defaults, launch profiles, health checks, and telemetry. - Removed the obsolete service discovery overview document. - Deleted the service defaults documentation file as part of the restructuring. * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 3872520 commit 6485cd6

30 files changed

+70
-766
lines changed

.openpublishing.redirection.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,22 @@
843843
{
844844
"source_path_from_root": "/docs/diagnostics/aspireazure002.md",
845845
"redirect_url": "https://aspire.dev/diagnostics/aspireazure002/"
846+
},
847+
{
848+
"source_path_from_root": "/docs/fundamentals/health-checks.md",
849+
"redirect_url": "https://aspire.dev/fundamentals/health-checks/"
850+
},
851+
{
852+
"source_path_from_root": "/docs/fundamentals/service-defaults.md",
853+
"redirect_url": "https://aspire.dev/fundamentals/service-defaults/"
854+
},
855+
{
856+
"source_path_from_root": "/docs/fundamentals/launch-profiles.md",
857+
"redirect_url": "https://aspire.dev/fundamentals/launch-profiles/"
858+
},
859+
{
860+
"source_path_from_root": "/docs/service-discovery/overview.md",
861+
"redirect_url": "https://aspire.dev/fundamentals/service-discovery/"
846862
}
847863
]
848864
}

docs/app-host/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The preceding launch settings file:
4444
- The `applicationUrl` property configures the dashboard launch address (`ASPNETCORE_URLS`).
4545
- Environment variables such as `ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL` and `ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL` are set on the AppHost.
4646

47-
For more information, see [Aspire and launch profiles](../fundamentals/launch-profiles.md).
47+
For more information, see [Aspire and launch profiles](https://aspire.dev/fundamentals/launch-profiles/).
4848

4949
> [!NOTE]
5050
> Configuration described on this page is for Aspire AppHost project. To configure the standalone dashboard, see [dashboard configuration](https://aspire.dev/dashboard/configuration/).

docs/deployment/aspire-deploy/application-insights.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ builder.Build().Run();
153153

154154
To make exporting to Azure Monitor simpler, this example uses the Azure Monitor Exporter Repo. This is a wrapper package around the Azure Monitor OpenTelemetry Exporter package that makes it easier to export to Azure Monitor with a set of common defaults.
155155

156-
Add the following package to the `ServiceDefaults` project, so that it will be included in each of the Aspire services. For more information, see [Aspire service defaults](../../fundamentals/service-defaults.md).
156+
Add the following package to the `ServiceDefaults` project, so that it will be included in each of the Aspire services. For more information, see [Aspire service defaults](https://aspire.dev/fundamentals/service-defaults/).
157157

158158
``` xml
159159
<PackageReference Include="Azure.Monitor.OpenTelemetry.AspNetCore"

docs/deployment/manifest-format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ builder.AddProject<Projects.AspireApp_Web>("webfrontend")
167167
builder.Build().Run();
168168
```
169169

170-
References between project resource types result in [service discovery](../service-discovery/overview.md) variables being injected into the referencing project. References to well known reference types such as Redis result in connection strings being injected.
170+
References between project resource types result in [service discovery](https://aspire.dev/fundamentals/service-discovery/) variables being injected into the referencing project. References to well known reference types such as Redis result in connection strings being injected.
171171

172172
:::image type="content" source="media/manifest-placeholder-strings.png" lightbox="media/manifest-placeholder-strings.png" alt-text="A diagram showing which resources contribute to which corresponding placeholder strings.":::
173173

@@ -920,4 +920,4 @@ When resources as configured as Azure resources, the `azure.bicep.v0` resource t
920920
- [Aspire overview](../get-started/aspire-overview.md)
921921
- [Aspire orchestration overview](../fundamentals/app-host-overview.md)
922922
- [Aspire integrations overview](../fundamentals/integrations-overview.md)
923-
- [Service discovery in Aspire](../service-discovery/overview.md)
923+
- [Service discovery in Aspire](https://aspire.dev/fundamentals/service-discovery/)

docs/extensibility/custom-client-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The registration of health checks, and telemetry are described in a bit more det
8787
8888
### Add health checks
8989
90-
[Health checks](../fundamentals/health-checks.md) are a way to monitor the health of an integration. With MailKit, you can check if the connection to the SMTP server is healthy. Add the following code to the `MailKit.Client` project in a file named _MailKitHealthCheck.cs_:
90+
[Health checks](https://aspire.dev/fundamentals/health-checks/) are a way to monitor the health of an integration. With MailKit, you can check if the connection to the SMTP server is healthy. Add the following code to the `MailKit.Client` project in a file named _MailKitHealthCheck.cs_:
9191
9292
:::code source="snippets/MailDevResourceAndComponent/MailKit.Client/MailKitHealthCheck.cs":::
9393

docs/extensibility/custom-hosting-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ dir
6060
Once the project is created, you should see a listing containing the following:
6161

6262
- `MailDevResource.AppHost`: The [AppHost](../fundamentals/app-host-overview.md) used to test out the custom resource.
63-
- `MailDevResource.ServiceDefaults`: The [service defaults](../fundamentals/service-defaults.md) project for use in service-related projects.
63+
- `MailDevResource.ServiceDefaults`: The [service defaults](https://aspire.dev/fundamentals/service-defaults/) project for use in service-related projects.
6464
- `MailDevResource.sln`: The solution file referencing both projects.
6565

6666
Verify that the project can build and run successfully by executing the following command:

docs/extensibility/dev-tunnels-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The preceding code:
9898

9999
### Service discovery integration
100100

101-
When another resource references a dev tunnel, environment variables are injected using the [Aspire service discovery](../service-discovery/overview.md) configuration format. Use the `WithReference` overloads that accept the `IResourceBuilder<DevTunnelResource>` parameter to reference a dev tunnel. This injects environment variables like:
101+
When another resource references a dev tunnel, environment variables are injected using the [Aspire service discovery](https://aspire.dev/fundamentals/service-discovery/) configuration format. Use the `WithReference` overloads that accept the `IResourceBuilder<DevTunnelResource>` parameter to reference a dev tunnel. This injects environment variables like:
102102

103103
```env
104104
WEB_HTTPS=https://myweb-1234.westeurope.devtunnels.ms/
@@ -180,5 +180,5 @@ Verify that:
180180

181181
- [Dev tunnels service documentation](/azure/developer/dev-tunnels/overview)
182182
- [Dev tunnels FAQ](/azure/developer/dev-tunnels/faq)
183-
- [Aspire service discovery](../service-discovery/overview.md)
183+
- [Aspire service discovery](https://aspire.dev/fundamentals/service-discovery/)
184184
- [Aspire networking overview](../fundamentals/networking-overview.md)

docs/extensibility/secure-communication-between-integrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The resulting solution from these previous articles contains the following proje
2424
- _MailDev.Hosting_: Contains the custom resource type for the MailDev container.
2525
- _MailDevResource.AppHost_: The [AppHost](../fundamentals/app-host-overview.md) that uses the custom resource and defines it as a dependency for a Newsletter service.
2626
- _MailDevResource.NewsletterService_: An ASP.NET Core Web API project that sends emails using the MailDev container.
27-
- _MailDevResource.ServiceDefaults_: Contains the [default service configurations](../fundamentals/service-defaults.md) intended for sharing.
27+
- _MailDevResource.ServiceDefaults_: Contains the [default service configurations](https://aspire.dev/fundamentals/service-defaults/) intended for sharing.
2828
- _MailKit.Client_: Contains the custom client integration that exposes the MailKit `SmtpClient` through a factory.
2929

3030
## Update the MailDev resource

docs/fundamentals/app-host-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ builder.AddProject<Projects.AspireApp_Web>("webfrontend")
194194
.WithReference(cache);
195195
```
196196

197-
The "webfrontend" project resource uses <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> to add a dependency on the "cache" container resource. These dependencies can represent connection strings or [service discovery](../service-discovery/overview.md) information. In the preceding example, an environment variable is _injected_ into the "webfrontend" resource with the name `ConnectionStrings__cache`. This environment variable contains a connection string that the `webfrontend` uses to connect to Redis via the [Aspire Redis integration](https://aspire.dev/integrations/caching/redis/), for example, `ConnectionStrings__cache="localhost:62354"`.
197+
The "webfrontend" project resource uses <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> to add a dependency on the "cache" container resource. These dependencies can represent connection strings or [service discovery](https://aspire.dev/fundamentals/service-discovery/) information. In the preceding example, an environment variable is _injected_ into the "webfrontend" resource with the name `ConnectionStrings__cache`. This environment variable contains a connection string that the `webfrontend` uses to connect to Redis via the [Aspire Redis integration](https://aspire.dev/integrations/caching/redis/), for example, `ConnectionStrings__cache="localhost:62354"`.
198198

199199
### Connection string and endpoint references
200200

@@ -226,7 +226,7 @@ Aspire injects two types of environment variables for service references:
226226
- **Simplified format** (e.g., `APISERVICE_HTTP`): Uses the pattern `{RESOURCENAME}_{ENDPOINTNAME}` in uppercase. This format is simpler and more suitable for non-.NET languages and polyglot scenarios.
227227
- **.NET service discovery format** (e.g., `services__apiservice__http__0`): Uses the pattern `services__{servicename}__{endpointname}__{index}` in lowercase. This format is used by .NET's configuration-based service discovery.
228228

229-
For more information, see [Aspire service discovery](../service-discovery/overview.md).
229+
For more information, see [Aspire service discovery](https://aspire.dev/fundamentals/service-discovery/).
230230

231231
To get specific endpoints from a <xref:Aspire.Hosting.ApplicationModel.ContainerResource> or an <xref:Aspire.Hosting.ApplicationModel.ExecutableResource>, use one of the following endpoint APIs:
232232

@@ -252,7 +252,7 @@ var apiservice = builder.AddProject<Projects.AspireApp_ApiService>("apiservice")
252252
|---------------------------|-------------------------------------------------------|
253253
| `WithReference(endpoint)` | `MYAPP_ENDPOINT="https://localhost:9043"` <br /> `services__myapp__endpoint__0="https://localhost:9043"` |
254254

255-
The `port` parameter is the port that the container is listening on. For more information on container ports, see [Container ports](networking-overview.md#container-ports). For more information on service discovery, see [Aspire service discovery](../service-discovery/overview.md).
255+
The `port` parameter is the port that the container is listening on. For more information on container ports, see [Container ports](networking-overview.md#container-ports). For more information on service discovery, see [Aspire service discovery](https://aspire.dev/fundamentals/service-discovery/).
256256

257257
### Service endpoint environment variable format
258258

@@ -377,7 +377,7 @@ This logic can easily be inverted to connect to an existing Redis resource when
377377
- [Aspire integrations overview](integrations-overview.md)
378378
- [Aspire SDK](dotnet-aspire-sdk.md)
379379
- [Eventing in Aspire](../app-host/eventing.md)
380-
- [Service discovery in Aspire](../service-discovery/overview.md)
381-
- [Aspire service defaults](service-defaults.md)
380+
- [Service discovery in Aspire](https://aspire.dev/fundamentals/service-discovery/)
381+
- [Aspire service defaults](https://aspire.dev/fundamentals/service-defaults/)
382382
- [Expressing external parameters](external-parameters.md)
383383
- [Aspire inner-loop networking overview](networking-overview.md)

docs/fundamentals/aspire-sdk-templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following Aspire solution templates are available, assume the solution is na
2727
- **Aspire Empty App**: A minimal Aspire project that includes the following:
2828

2929
- [**AspireSample.AppHost**](#app-host): An orchestrator project designed to connect and configure the different projects and services of your app.
30-
- [**AspireSample.ServiceDefaults**](#service-defaults): A Aspire shared project to manage configurations that are reused across the projects in your solution related to [resilience](/dotnet/core/resilience/http-resilience), [service discovery](../service-discovery/overview.md), and [telemetry](telemetry.md).
30+
- [**AspireSample.ServiceDefaults**](#service-defaults): A Aspire shared project to manage configurations that are reused across the projects in your solution related to [resilience](/dotnet/core/resilience/http-resilience), [service discovery](https://aspire.dev/fundamentals/service-discovery/), and [telemetry](telemetry.md).
3131

3232
<a name="starter-app"></a>
3333

@@ -59,10 +59,10 @@ The following Aspire project templates are available:
5959

6060
<a name="service-defaults"></a>
6161

62-
- **Aspire Service Defaults**: A standalone **.ServiceDefaults** project that can be used to manage configurations that are reused across the projects in your solution related to [resilience](/dotnet/core/resilience/http-resilience), [service discovery](../service-discovery/overview.md), and [telemetry](./telemetry.md).
62+
- **Aspire Service Defaults**: A standalone **.ServiceDefaults** project that can be used to manage configurations that are reused across the projects in your solution related to [resilience](/dotnet/core/resilience/http-resilience), [service discovery](https://aspire.dev/fundamentals/service-discovery/), and [telemetry](./telemetry.md).
6363

6464
> [!IMPORTANT]
65-
> The service defaults project template takes a `FrameworkReference` dependency on `Microsoft.AspNetCore.App`. This may not be ideal for some project types. For more information, see [Aspire service defaults](service-defaults.md).
65+
> The service defaults project template takes a `FrameworkReference` dependency on `Microsoft.AspNetCore.App`. This may not be ideal for some project types. For more information, see [Aspire service defaults](https://aspire.dev/fundamentals/service-defaults/).
6666
6767
## Install the Aspire templates
6868

0 commit comments

Comments
 (0)