Skip to content

Commit

Permalink
Rewrite the non-Azure messaging integration articles (#1759)
Browse files Browse the repository at this point in the history
* Initial bits

* Fix images

* More clean up

* Fix MD error

* Add keyed services

* Simplify long API xref

* Add a bit more detail

* Address feedback

* Update SVGs

* Revert to yes/no icons

* Link to management docker

* Larger link

* edit pass

* Add details about run cmd

* Add extension target

* Correct example

* Add a bit more detail about container

* quick edit pass

* Done

* Rewrite Kafka

* Fix xref

* Rewrite NATS

* Oops, remove copy/pasta

* Apply suggestions from code review

Co-authored-by: Andy (Steve) De George <67293991+adegeo@users.noreply.github.com>

* Apply a bit more feedback to other content

* add callout about bind mount vs volume

---------

Co-authored-by: Andy (Steve) De George <67293991+adegeo@users.noreply.github.com>
  • Loading branch information
IEvangelist and adegeo authored Oct 10, 2024
1 parent c6b9b6e commit 16d500d
Show file tree
Hide file tree
Showing 62 changed files with 733 additions and 350 deletions.
4 changes: 4 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,10 @@
{
"source_path_from_root": "/docs/extensibility/implement-auth-from-resource-to-integration.md",
"redirect_url": "/dotnet/aspire/extensibility/secure-communication-between-integrations"
},
{
"source_path_from_root": "/docs/messaging/rabbitmq-client-integration.md",
"redirect_url": "/dotnet/aspire/messaging/rabbitmq-integration"
}
]
}
2 changes: 0 additions & 2 deletions docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,12 @@
"docs/**/*.*": "IEvangelist",
"docs/database/**/*.*": "CamSoper",
"docs/storage/**/*.*": "CamSoper",
"docs/messaging/**/*.*": "CamSoper",
"docs/deployment/**/*.*": "CamSoper"
},
"ms.author": {
"docs/**/*.*": "dapine",
"docs/database/**/*.*": "casoper",
"docs/storage/**/*.*": "casoper",
"docs/messaging/**/*.*": "casoper",
"docs/deployment/**/*.*": "casoper"
},
"ms.collection": {
Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/keycloak-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dotnet add package Aspire.Keycloak.Authentication

```xml
<PackageReference Include="Aspire.Keycloak.Authentication"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -84,7 +84,7 @@ dotnet add package Aspire.Hosting.Keycloak

```xml
<PackageReference Include="Aspire.Hosting.Keycloak"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/azureai/azureai-openai-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Azure.AI.OpenAI

```xml
<PackageReference Include="Aspire.Azure.AI.OpenAI"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -66,7 +66,7 @@ dotnet add package Aspire.Hosting.Azure.CognitiveServices

```xml
<PackageReference Include="Aspire.Hosting.Azure.CognitiveServices"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/azureai/azureai-search-document-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dotnet add package Aspire.Azure.Search.Documents

```xml
<PackageReference Include="Aspire.Azure.Search.Documents"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -87,7 +87,7 @@ dotnet add package Aspire.Hosting.Azure.Search

```xml
<PackageReference Include="Aspire.Hosting.Azure.Search"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/caching/caching-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Visual Studio creates a new .NET Aspire solution that consists of the following

```xml
<PackageReference Include="Aspire.Hosting.Redis"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/caching/includes/garnet-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.Garnet

```xml
<PackageReference Include="Aspire.Hosting.Garnet"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/caching/includes/redis-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.Redis

```xml
<PackageReference Include="Aspire.Hosting.Redis"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/caching/includes/valkey-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.Valkey

```xml
<PackageReference Include="Aspire.Hosting.Valkey"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ dotnet add package Aspire.StackExchange.Redis.DistributedCaching

```xml
<PackageReference Include="Aspire.StackExchange.Redis.DistributedCaching"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/caching/stackexchange-redis-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ dotnet add package Aspire.StackExchange.Redis

```xml
<PackageReference Include="Aspire.StackExchange.Redis"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ dotnet add package Aspire.StackExchange.Redis.OutputCaching

```xml
<PackageReference Include="Aspire.StackExchange.Redis.OutputCache"
Version="[SelectVersion]" />
Version="*" />
```

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

```xml
<PackageReference Include="Aspire.Microsoft.EntityFrameworkCore.Cosmos"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -63,7 +63,7 @@ dotnet add package Aspire.Hosting.Azure.CosmosDB

```xml
<PackageReference Include="Aspire.Hosting.Azure.CosmosDB"
Version="[SelectVersion]" />
Version="*" />
```

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

```xml
<PackageReference Include="Aspire.Microsoft.Azure.Cosmos"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -63,7 +63,7 @@ dotnet add package Aspire.Hosting.Azure.CosmosDB

```xml
<PackageReference Include="Aspire.Hosting.Azure.CosmosDB"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/includes/mysql-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.MySql

```xml
<PackageReference Include="Aspire.Hosting.MySql"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/includes/postgresql-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.PostgreSQL

```xml
<PackageReference Include="Aspire.Hosting.PostgreSQL"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/includes/postgresql-flexible-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ dotnet add package Aspire.Hosting.Azure.PostgreSQL

```xml
<PackageReference Include="Aspire.Hosting.Azure.PostgreSQL"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/includes/sql-app-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dotnet add package Aspire.Hosting.SqlServer

```xml
<PackageReference Include="Aspire.Hosting.SqlServer"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/database/milvus-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ dotnet add package Aspire.Milvus.Client

```xml
<PackageReference Include="Aspire.Milvus.Client"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -56,7 +56,7 @@ dotnet add package Aspire.Hosting.Milvus

```xml
<PackageReference Include="Aspire.Hosting.Milvus"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/database/mongodb-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ dotnet add package Aspire.MongoDB.Driver

```xml
<PackageReference Include="Aspire.MongoDB.Driver"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -72,7 +72,7 @@ dotnet add package Aspire.Hosting.MongoDB

```xml
<PackageReference Include="Aspire.Hosting.MongoDB"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/mysql-entity-framework-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql

```xml
<PackageReference Include="Aspire.Pomelo.EntityFrameworkCore.MySql"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/mysql-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ dotnet add package Aspire.MySqlConnector

```xml
<PackageReference Include="Aspire.MySqlConnector"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/database/oracle-entity-framework-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dotnet add package Aspire.Oracle.EntityFrameworkCore

```xml
<PackageReference Include="Aspire.Oracle.EntityFrameworkCore"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -71,7 +71,7 @@ dotnet add package Aspire.Hosting.Oracle

```xml
<PackageReference Include="Aspire.Hosting.Oracle"
Version="[SelectVersion]" />
Version="*" />
```

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

```xml
<PackageReference Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/database/postgresql-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dotnet add package Aspire.Npgsql
### [PackageReference](#tab/package-reference)

```xml
<PackageReference Include="Aspire.Npgsql" Version="[SelectVersion]" />
<PackageReference Include="Aspire.Npgsql" Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/database/qdrant-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ dotnet add package Aspire.Qdrant.Client

```xml
<PackageReference Include="Aspire.Qdrant.Client"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -61,7 +61,7 @@ dotnet add package Aspire.Hosting.Qdrant

```xml
<PackageReference Include="Aspire.Hosting.Qdrant"
Version="[SelectVersion]" />
Version="*" />
```

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

```xml
<PackageReference Include="Aspire.Microsoft.EntityFrameworkCore.SqlServer"
Version="[SelectVersion]" />
Version="*" />
```

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

```xml
<PackageReference Include="Aspire.Microsoft.Data.SqlClient"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/azure/application-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Add the following package to the `ServiceDefaults` project, so that it will be i

``` xml
<PackageReference Include="Azure.Monitor.OpenTelemetry.AspNetCore"
Version="[SelectVersion]" />
Version="*" />
```

Add a using statement to the top of the project.
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/azure/custom-bicep-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ dotnet add package Aspire.Hosting.Azure

```xml
<PackageReference Include="Aspire.Hosting.Azure"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
4 changes: 2 additions & 2 deletions docs/frameworks/dapr.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ dotnet add package Aspire.Hosting.Dapr

```xml
<PackageReference Include="Aspire.Hosting.Dapr"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down Expand Up @@ -87,7 +87,7 @@ dotnet add package Dapr.AspNetCore

```xml
<PackageReference Include="Dapr.AspNetCore"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/frameworks/orleans.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ dotnet add package Aspire.Hosting.Orleans

```xml
<PackageReference Include="Aspire.Hosting.Orleans"
Version="[SelectVersion]" />
Version="*" />
```

---
Expand Down
Loading

0 comments on commit 16d500d

Please sign in to comment.