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

Update Aspire integration documentation #1611

Open
davidfowl opened this issue Sep 8, 2024 · 0 comments · May be fixed by #1648
Open

Update Aspire integration documentation #1611

davidfowl opened this issue Sep 8, 2024 · 0 comments · May be fixed by #1648
Assignees
Labels
docs-experience Indicates issues that are about the learn.microsoft.com experience or design [org][type][category] documentation Improvements or additions to documentation dotnet-aspire/prod in-pr okr-quality Content-health KR: Concerns article defects/freshness or build warnings. Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@davidfowl
Copy link
Member

davidfowl commented Sep 8, 2024

Integrations are the term used to describe both hosting and library integrations.

Hosting integrations exist to provide configuration for the application. These packages provide configuration by provisioning resources (such as containers, or cloud resources) or pointing at existing ones (a local SQL server for example). This configuration is usually consumed by a client/libary integration package that understands this configuration schema.

Client/Library integrations define configuration schema, wire up client libraries to DI, add health checks, resiliency and telemetry.

Hosting and client/library integrations are best when used together, but are NOT coupled and may be used separately (some hosting integrations may not have a library integration for e.g.). Configuration is what makes the hosting integration work with the client library integration.

We should refocus the apphost overview on the core building blocks (what is there already) and how the orchestration model works (pointing to other articles like networking and parameters). We should move the list of packages and move them to the integrations page.

We should also move Dapr and Orleans under integrations and delete the frameworks node.

Under the extensibility node:

image

Creating custom integrations should be top level, and below it should be "hosting integration" and "library integration".


Associated WorkItem - 310941

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Sep 8, 2024
@IEvangelist IEvangelist self-assigned this Sep 9, 2024
@IEvangelist IEvangelist added documentation Improvements or additions to documentation 🗺️ reQUEST Triggers an issue to be imported into Quest. Pri1 High priority, do before Pri2 and Pri3 docs-experience Indicates issues that are about the learn.microsoft.com experience or design [org][type][category] dotnet-aspire/prod okr-quality Content-health KR: Concerns article defects/freshness or build warnings. and removed ⌚ Not Triaged Not triaged labels Sep 12, 2024
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-experience Indicates issues that are about the learn.microsoft.com experience or design [org][type][category] documentation Improvements or additions to documentation dotnet-aspire/prod in-pr okr-quality Content-health KR: Concerns article defects/freshness or build warnings. Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
Status: 🔖 Ready
Development

Successfully merging a pull request may close this issue.

3 participants