Skip to content

Rework TOC #928

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 6 commits into from
May 17, 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
2 changes: 1 addition & 1 deletion docs/extensibility/custom-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Create custom resource types for .NET Aspire
description: Learn how to create a custom resource for an existing containerized application.
ms.date: 05/14/2024
ms.topic: tutorial
ms.topic: how-to
ms.custom: devx-track-extended-azdevcli
---

Expand Down
8 changes: 4 additions & 4 deletions docs/frameworks/orleans.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use Orleans with .NET Aspire
description: Learn how to use Orleans with .NET Aspire
ms.date: 05/14/2024
ms.date: 05/17/2024
ms.topic: overview
---

Expand All @@ -11,10 +11,10 @@ Orleans has in-built support for .NET Aspire. .NET Aspire's application model le

Orleans is represented as a resource in .NET Aspire. The Orleans resource includes configuration which your service needs to operate, such as cluster membership providers and storage providers.

## Prerequisites
[!INCLUDE [aspire-prereqs](../includes/aspire-prereqs.md)]

In addition to the prerequisites for .NET Aspire, you will need:

- .NET 8.0 SDK or later
- .NET Aspire workload
- Orleans version 8.1.0 or later

For more information, see [.NET Aspire setup and tooling](../fundamentals/setup-tooling.md).
Expand Down
3 changes: 2 additions & 1 deletion docs/fundamentals/components-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
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: 05/15/2024
ms.date: 05/17/2024
ms.topic: conceptual
---

Expand All @@ -26,6 +26,7 @@ The following table lists the .NET Aspire components currently available for use
| [Azure Blob Storage](../storage/azure-storage-blobs-component.md) | [Aspire.Azure.Storage.Blobs](https://www.nuget.org/packages/Aspire.Azure.Storage.Blobs) | A library for accessing [Azure Blob Storage](/azure/storage/blobs/storage-blobs-introduction). |
| [Azure Cosmos DB Entity Framework Core](../database/azure-cosmos-db-entity-framework-component.md) | [Aspire.Microsoft.EntityFrameworkCore.Cosmos](https://www.nuget.org/packages/Aspire.Microsoft.EntityFrameworkCore.Cosmos) | A library for accessing Azure Cosmos DB databases with [Entity Framework Core](/ef/core/providers/cosmos/). |
| [Azure Cosmos DB](../database/azure-cosmos-db-component.md) | [Aspire.Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Aspire.Microsoft.Azure.Cosmos) | A library for accessing [Azure Cosmos DB](/azure/cosmos-db/introduction) databases. |
| [Azure Event Hubs](../messaging/azure-event-hubs-component.md) | [Aspire.Azure.Messaging.EventHubs](https://www.nuget.org/packages/Aspire.Azure.Messaging.EventHubs) | A library for accessing [Azure Event Hubs](/azure/event-hubs/event-hubs-about). |
| [Azure Key Vault](../security/azure-security-key-vault-component.md) | [Aspire.Azure.Security.KeyVault](https://www.nuget.org/packages/Aspire.Azure.Security.KeyVault) | A library for accessing [Azure Key Vault](/azure/key-vault/general/overview). |
| [Azure Service Bus](../messaging/azure-service-bus-component.md) | [Aspire.Azure.Messaging.ServiceBus](https://www.nuget.org/packages/Aspire.Azure.Messaging.ServiceBus) | A library for accessing [Azure Service Bus](/azure/service-bus-messaging/service-bus-messaging-overview). |
| [Azure Storage Queues](../storage/azure-storage-queues-component.md) | [Aspire.Azure.Storage.Queues](https://www.nuget.org/packages/Aspire.Azure.Storage.Queues) | A library for accessing [Azure Storage Queues](/azure/storage/queues/storage-queues-introduction). |
Expand Down
1 change: 1 addition & 0 deletions docs/fundamentals/external-parameters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: External parameters
description: Learn how to express parameters such as secrets, connection strings, and other configuration values that might vary between environments.
ms.topic: how-to
ms.date: 03/01/2024
---

Expand Down
2 changes: 1 addition & 1 deletion docs/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ conceptualContent:
text: Orleans voting sample
url: /samples/dotnet/aspire-samples/orleans-voting-sample-app-on-aspire/
- itemType: sample
text: Dapr sample
text: Dapr integration sample
url: /samples/dotnet/aspire-samples/aspire-dapr/

- title: Deployment
Expand Down
200 changes: 108 additions & 92 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ items:
href: index.yml

- name: Get Started
expanded: true
items:
- name: .NET Aspire overview
displayName: aspire overview,architecture,key concepts
Expand Down Expand Up @@ -38,132 +37,131 @@ items:
href: fundamentals/dashboard/configuration.md
- name: Security considerations
href: fundamentals/dashboard/security-considerations.md
- name: Components
displayName: aspire components,components,nuget packages,packages
href: fundamentals/components-overview.md
- name: Networking overview
displayName: inner loop,local networking
href: fundamentals/networking-overview.md
- name: Service discovery
displayName: service discovery,service to service communication
href: service-discovery/overview.md
- name: .NET Aspire and launch profiles
href: fundamentals/launch-profiles.md
- name: Testing .NET Aspire apps
href: fundamentals/testing.md
- name: Service defaults
href: fundamentals/service-defaults.md
- name: External parameters
href: fundamentals/external-parameters.md
- name: Persist data using volumes
href: fundamentals/persist-data-volumes.md
- name: Health checks
href: fundamentals/health-checks.md
- name: Telemetry
href: fundamentals/telemetry.md

- name: Azure AI
- name: Components
items:
- name: Overview
displayName: aspire components,components,nuget packages,packages
href: fundamentals/components-overview.md
- name: Tutorials
items:
- name: Caching using Redis components
displayName: caching,redis
href: caching/caching-components.md
- name: Connect to SQL Server with EF Core
displayName: database,sql server,ef core
href: database/sql-server-components.md
- name: Connect to storage
href: storage/azure-storage-components.md
- name: Database initialization and maintenance
items:
- name: Entity Framework Core migrations
href: database/ef-core-migrations.md
- name: Seed data in a database
href: database/seed-database-data.md
- name: Messaging using .NET Aspire components
displayName: messaging
href: messaging/messaging-components.md
- name: Apache Kafka component
displayName: kafka,messaging
href: messaging/kafka-component.md
- name: Azure AI OpenAI component
displayName: azure ai,openai
href: azureai/azureai-openai-component.md
- name: Azure AI Search Documents component
- name: Azure Search Documents component
displayName: azure search,search,azure ai
href: azureai/azureai-search-document-component.md

- name: Storage
items:
- name: Tutorial - Connect to storage
href: storage/azure-storage-components.md
- name: Azure Blob Storage component
href: storage/azure-storage-blobs-component.md
- name: Azure Cosmos DB components
items:
- name: Azure Cosmos DB - EF Core component
displayName: cosmos db,database,ef core
href: database/azure-cosmos-db-entity-framework-component.md
- name: Azure Cosmos DB component
displayName: cosmos db,database
href: database/azure-cosmos-db-component.md
- name: Azure Event Hubs component
displayName: event hubs,messaging
href: messaging/azure-event-hubs-component.md
- name: Azure Key Vault component
displayName: key vault,security
href: security/azure-security-key-vault-component.md
- name: Azure Service Bus component
displayName: service bus,messaging
href: messaging/azure-service-bus-component.md
- name: Azure Storage Queues component
displayName: storage queues,azure storage
href: storage/azure-storage-queues-component.md
- name: Azure Table Storage component
displayName: table storage,azure storage
href: storage/azure-storage-tables-component.md

- name: Logging
items:
- name: Seq component
href: logging/seq-component.md

- name: Database
items:
- name: MongoDB component
displayName: mongodb,database
href: database/mongodb-component.md
- name: MySQL Database component
displayName: mysql,database
href: database/mysql-component.md
- name: NATS component
displayName: nats,messaging
href: messaging/nats-component.md
- name: Oracle Database - EF Core component
displayName: oracle,database,ef core
href: database/oracle-entity-framework-component.md
- name: PostgreSQL Database components
items:
- name: PostgreSQL Database component
displayName: postgresql,database
href: database/postgresql-component.md
- name: PostgreSQL - EF Core component
displayName: postgresql,database,ef core
href: database/postgresql-entity-framework-component.md
- name: SQL Database components
items:
- name: Tutorial - Connect to SQL Server with EF Core
href: database/sql-server-components.md
- name: SQL Database component
href: database/sql-server-component.md
- name: SQL Database - EF Core component
href: database/sql-server-entity-framework-component.md
- name: Azure Cosmos DB components
items:
- name: Azure Cosmos DB component
href: database/azure-cosmos-db-component.md
- name: Azure Cosmos DB - EF Core component
href: database/azure-cosmos-db-entity-framework-component.md
- name: MySQL Database component
href: database/mysql-component.md
- name: MongoDB component
href: database/mongodb-component.md
- name: Oracle Database - EF Core component
href: database/oracle-entity-framework-component.md
- name: Database initialization and maintenance
items:
- name: Seed data in a database
href: database/seed-database-data.md
- name: Entity Framework Core migrations
href: database/ef-core-migrations.md

- name: Real-time communication
items:
- name: Azure SignalR Service scenario
href: real-time/azure-signalr-scenario.md

- name: Messaging
items:
- name: Tutorial - Messaging using .NET Aspire components
href: messaging/messaging-components.md
- name: Azure Event Hubs component
href: messaging/azure-event-hubs-component.md
- name: Azure Service Bus component
href: messaging/azure-service-bus-component.md
- name: RabbitMQ service broker component
displayName: rabbitmq,messaging,service broker
href: messaging/rabbitmq-client-component.md
- name: Apache Kafka component
href: messaging/kafka-component.md
- name: NATS component
href: messaging/nats-component.md

- name: Caching
items:
- name: Tutorial - Caching using Redis components
href: caching/caching-components.md
- name: Redis Caching component
displayName: caching
href: caching/stackexchange-redis-component.md
- name: Redis Output Caching component
href: caching/stackexchange-redis-output-caching-component.md
- name: Redis Distributed Cache component
displayName: distributed caching
href: caching/stackexchange-redis-distributed-caching-component.md
- name: Redis Output Caching component
displayName: output caching
href: caching/stackexchange-redis-output-caching-component.md
- name: SQL Database components
items:
- name: SQL Database component
displayName: sql server,sql database
href: database/sql-server-component.md
- name: SQL Database - EF Core component
displayName: sql server,sql database,ef core
href: database/sql-server-entity-framework-component.md
- name: Seq component
displayName: seq,logging
href: logging/seq-component.md

- name: Security
items:
- name: Azure Key Vault component
href: security/azure-security-key-vault-component.md

- name: Deployment
- name: Cloud
items:
- name: Overview
href: deployment/overview.md
- name: Azure
items:
- name: Local Azure provisioning
href: deployment/azure/local-provisioning.md
- name: Local Azure provisioning
href: deployment/azure/local-provisioning.md
- name: Deployment
items:
- name: Overview
href: deployment/overview.md
- name: Deploy to Azure Container Apps using AZD
href: deployment/azure/aca-deployment.md
displayName: azure container apps,aca
Expand All @@ -182,17 +180,31 @@ items:
href: database/sql-server-component-deployment.md
- name: Deploy .NET Aspire + Redis
href: caching/caching-components-deployment.md
- name: Reference - Tool-builder manifest schemas
- name: Azure SignalR Service scenario
displayName: azure signalr service,signalr,real-time
href: real-time/azure-signalr-scenario.md
- name: Tool-builder manifest schemas
href: deployment/manifest-format.md

- name: Frameworks
items:
- name: Orleans
href: frameworks/orleans.md
- name: Orleans voting sample
href: /samples/dotnet/aspire-samples/orleans-voting-sample-app-on-aspire/
- name: Dapr integration sample
href: /samples/dotnet/aspire-samples/aspire-dapr/

- name: Extensibility
- name: How-tos
items:
- name: Use external parameters
displayName: external parameters,configuration
href: fundamentals/external-parameters.md
- name: Persist data using volumes
displayName: volumes,persist data
href: fundamentals/persist-data-volumes.md
- name: Create custom resource types
displayName: custom resources,extensibility
href: extensibility/custom-resources.md

- name: Troubleshooting
Expand All @@ -214,10 +226,14 @@ items:

- name: Reference
items:
- name: .NET Aspire API reference
href: /dotnet/api?view=dotnet-aspire-8.0&preserve-view=true
- name: .NET Aspire and launch profiles
href: fundamentals/launch-profiles.md
- name: Diagnostics overview
href: diagnostics/overview.md
- name: Health checks
href: fundamentals/health-checks.md
- name: .NET Aspire API reference
href: /dotnet/api?view=dotnet-aspire-8.0&preserve-view=true
- name: .NET Aspire FAQ
href: reference/aspire-faq.yml

Expand Down
Loading