Skip to content

Enhance Dev Container documentation with comprehensive scenarios and examples #3849

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 18, 2025

This PR significantly enhances the Dev Container documentation to address the comprehensive requirements outlined in the community feedback. The original docs/get-started/dev-containers.md provided basic setup instructions but lacked coverage of advanced scenarios that developers commonly encounter when using .NET Aspire in containerized development environments.

Changes Made

Enhanced docs/get-started/dev-containers.md with detailed scenarios and configurations:

New Dev Container Scenarios Added

  • Stateless .NET apps: Minimal configuration for projects using only .NET project resources
  • Node.js integration: Setup for mixed .NET/Node.js applications with appropriate features
  • Docker-in-Docker (DinD): Container orchestration with networking considerations and IPv6 configuration
  • Dapr integration: Both basic setup and complex scenarios with external backends
  • Infrastructure/Bicep: Azure deployment tooling and Bicep file support
  • Kubernetes deployment: Aspirate integration for Kubernetes deployment workflows

Additional Improvements

  • Common considerations section covering resource requirements, networking, performance, and security
  • Cross-references to related documentation (Dapr integration, GitHub Codespaces, Dockerfile integration)
  • "See also" section with relevant internal and external links
  • Docker-in-Docker considerations including IPv6 configuration, resource allocation, and platform compatibility notes

Coverage of Original Requirements

✅ Stateless .NET apps only
✅ Node.js resource integration
✅ Container resources with DinD, IPv6 args, and implications
✅ Dapr examples (in-memory and external backends)
✅ Aspirate/Kubernetes deployment examples
✅ Bicep/infrastructure scenarios
✅ Resource allocation and networking considerations

Technical Details

  • Added 268 net new lines of content without removing existing documentation
  • All markdown linting passes successfully
  • Maintained consistency with existing documentation style and structure
  • Provided practical, copy-paste ready devcontainer.json examples for each scenario

This enhancement transforms the basic Dev Container guide into a comprehensive reference that covers all major .NET Aspire development scenarios in containerized environments, making it significantly easier for developers to choose and configure the right setup for their specific needs.

Fixes #540.


💬 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/get-started/dev-containers.md docs/get-started/dev-containers

@Copilot Copilot AI changed the title [WIP] Development Containers (Hollistic Issue) Enhance Dev Container documentation with comprehensive scenarios and examples Jun 18, 2025
@Copilot Copilot AI requested a review from IEvangelist June 18, 2025 16:45
Copilot finished work on behalf of IEvangelist June 18, 2025 16:45
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.

Development Containers (Hollistic Issue)
2 participants