Skip to content

Add non-.NET usage sections to integration docs to address misconceptions #4052

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 3 commits into from
Jul 18, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 15, 2025

The integration documentation was inadvertently promoting the misconception that Aspire is .NET-only, leading to organizations dismissing it for applications with non-.NET components or those preferring not to use client integration packages.

Changes Made

Enhanced Integrations Overview

  • Clarified that hosting integrations work with any application type, not just .NET applications
  • Distinguished that client integrations are .NET-specific but hosting integrations can be used independently
  • Explained how hosting integrations inject configuration via environment variables to any technology

Added "Using with non-.NET applications" sections

Added practical examples to popular integrations showing how to consume them without client packages:

SQL Server integration:

var app = builder.AddExecutable("my-app", "python", "app.py", ".")
    .WithReference(database) // Provides ConnectionStrings__myDatabase
    .WithEnvironment(context =>
    {
        context.EnvironmentVariables["SQL_SERVER"] = sql.Resource.PrimaryEndpoint.Property(EndpointProperty.Host);
        context.EnvironmentVariables["SQL_PORT"] = sql.Resource.PrimaryEndpoint.Property(EndpointProperty.Port);
        context.EnvironmentVariables["SQL_USERNAME"] = "sa";
        context.EnvironmentVariables["SQL_PASSWORD"] = sql.Resource.PasswordParameter;
        context.EnvironmentVariables["SQL_DATABASE"] = database.Resource.DatabaseName;
    });

PostgreSQL and Redis integrations receive similar treatment with technology-appropriate examples.

Impact

This addresses two key misconceptions:

  1. ❌ "We can't use Aspire as we have components that aren't .NET based"
  2. ❌ "We can't/don't want to use the client integration packages"

The documentation now clearly shows that:

  • ✅ Hosting integrations provide infrastructure for any application technology
  • ✅ Applications consume connection details via standard environment variables
  • No Aspire packages need to be shipped to production applications
  • ✅ Works with Python, Node.js, Go, and any technology that can read environment variables

Files Changed

  • docs/fundamentals/integrations-overview.md - Enhanced hosting integrations explanation
  • docs/database/sql-server-integration.md - Added non-.NET usage section
  • docs/database/postgresql-integration.md - Added non-.NET usage section
  • docs/caching/stackexchange-redis-integration.md - Added non-.NET usage section

The established pattern can be applied to other integrations as needed.

Fixes #1763.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/caching/stackexchange-redis-integration.md docs/caching/stackexchange-redis-integration
docs/database/postgresql-integration.md docs/database/postgresql-integration
docs/database/sql-server-integration.md docs/database/sql-server-integration
docs/fundamentals/integrations-overview.md docs/fundamentals/integrations-overview

@Copilot Copilot AI changed the title [WIP] Integration docs promote misconception that Aspire is .Net only. Add non-.NET usage sections to integration docs to address misconceptions Jul 15, 2025
@Copilot Copilot AI requested a review from IEvangelist July 15, 2025 17:22
Copilot finished work on behalf of IEvangelist July 15, 2025 17:22
@IEvangelist IEvangelist marked this pull request as ready for review July 17, 2025 19:32
@IEvangelist IEvangelist requested a review from adegeo July 17, 2025 19:32
@IEvangelist IEvangelist enabled auto-merge (squash) July 17, 2025 19:32
@IEvangelist IEvangelist requested a review from tdykstra July 18, 2025 14:47
@IEvangelist IEvangelist merged commit 06a6287 into main Jul 18, 2025
17 checks passed
@IEvangelist IEvangelist deleted the copilot/fix-1763 branch July 18, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integration docs promote misconception that Aspire is .Net only.
3 participants