Skip to content

Latest commit

 

History

History
1171 lines (955 loc) · 65.1 KB

File metadata and controls

1171 lines (955 loc) · 65.1 KB

Changelog - AZD For Beginners

Introduction

This changelog documents all notable changes, updates, and improvements to the AZD For Beginners repository. We follow semantic versioning principles and maintain this log to help users understand what has changed between versions.

Learning Goals

By reviewing this changelog, you will:

  • Stay informed about new features and content additions
  • Understand improvements made to existing documentation
  • Track bug fixes and corrections to ensure accuracy
  • Follow the evolution of the learning materials over time

Learning Outcomes

After reviewing changelog entries, you will be able to:

  • Identify new content and resources available for learning
  • Understand which sections have been updated or improved
  • Plan your learning path based on the most current materials
  • Contribute feedback and suggestions for future improvements

Version History

[v3.19.1] - 2026-03-27

Beginner Onboarding Clarification, Setup Validation & Final AZD Command Cleanup

This version follows up the AZD 1.23 validation sweep with a beginner-focused documentation pass: it clarifies AZD-first authentication guidance, adds local setup validation scripts, verifies key commands against the live AZD CLI, and removes the last obsolete English-source command references outside the changelog.

Added

  • 🧪 Beginner setup validation scripts with validate-setup.ps1 and validate-setup.sh so learners can confirm required tools before starting Chapter 1
  • ✅ Upfront setup validation steps in the root README and Chapter 1 README so missing prerequisites are caught before azd up

Changed

  • 🔐 Beginner authentication guidance now consistently treats azd auth login as the primary path for AZD workflows, with az login called out as optional unless Azure CLI commands are used directly
  • 📚 Chapter 1 onboarding flow now points learners to validate their local setup before installation, authentication, and first deployment steps
  • 🛠️ Validator messaging now clearly separates blocking requirements from optional Azure CLI warnings for the AZD-only beginner path
  • 📖 Configuration, troubleshooting, and example docs now distinguish between required AZD authentication and optional Azure CLI sign-in where both were previously presented without context

Fixed

  • 📋 Remaining English-source command references updated to current AZD forms, including azd config show in the cheat sheet and azd monitor --overview where Azure Portal overview guidance was intended
  • 🧭 Beginner claims in Chapter 1 softened to avoid overpromising guaranteed zero-error or rollback behavior across all templates and Azure resources
  • 🔎 Live CLI validation confirmed current support for azd env get-values, azd template list, azd extension list --installed, azd copilot consent list, azd mcp start, azd provision --preview, azd monitor --logs, and azd down --force --purge

Files Updated

  • README.md
  • changelog.md
  • docs/chapter-01-foundation/README.md
  • docs/chapter-01-foundation/azd-basics.md
  • docs/chapter-01-foundation/installation.md
  • docs/chapter-01-foundation/first-project.md
  • docs/chapter-03-configuration/README.md
  • docs/chapter-07-troubleshooting/README.md
  • examples/container-app/README.md
  • examples/database-app/README.md
  • resources/cheat-sheet.md
  • validate-setup.ps1
  • validate-setup.sh

[v3.19.0] - 2026-03-26

AZD 1.23.12 Validation, Workshop Environment Expansion & AI Model Refresh

This version performs a documentation validation sweep against azd 1.23.12, updates outdated AZD command examples, refreshes AI model guidance to current defaults, and broadens the workshop instructions beyond GitHub Codespaces to also support dev containers and local clones.

Added

  • ✅ Validation notes across core chapters and workshop docs to make the tested AZD baseline explicit for learners using newer or older CLI builds
  • ⏱️ Deployment timeout guidance for long-running AI app deployments using azd deploy --timeout 1800
  • 🔎 Extension inspection steps with azd extension show azure.ai.agents in AI workflow docs
  • 🌐 Broader workshop environment guidance covering GitHub Codespaces, dev containers, and local clones with MkDocs

Changed

  • 📚 Chapter intro READMEs now consistently note validation against azd 1.23.12 across foundation, configuration, infrastructure, multi-agent, pre-deployment, troubleshooting, and production sections
  • 🛠️ AZD command references updated to current forms across the docs:
    • azd config listazd config show
    • azd env showazd env list or azd env get-value(s) depending on context
    • azd auth whoamiazd auth status
    • azd monitorazd monitor --overview where Application Insights overview is intended
  • 🧪 Provision preview examples simplified to current supported usage such as azd provision --preview and azd provision --preview -e production
  • 🧭 Workshop flow updated so learners can complete the labs in Codespaces, a dev container, or a local clone instead of assuming Codespaces-only execution
  • 🔐 Authentication guidance now prefers azd auth login for AZD workflows, with az login positioned as optional when Azure CLI commands are used directly

Fixed

  • 🪟 Windows install commands normalized to current winget package casing in the installation guide
  • 🐧 Linux install guidance corrected to avoid unsupported distro-specific azd package manager instructions and instead point to release assets where appropriate
  • 📦 AI model examples refreshed from older defaults like gpt-35-turbo and text-embedding-ada-002 to current examples such as gpt-4.1-mini, gpt-4.1, and text-embedding-3-large
  • 📋 Deployment and diagnostics snippets corrected to use current environment and status commands in logs, scripts, and troubleshooting steps
  • ⚙️ GitHub Actions guidance updated from Azure/setup-azd@v1.0.0 to Azure/setup-azd@v2
  • 🤖 MCP/Copilot consent guidance updated from azd mcp consent to azd copilot consent list

Improved

  • 🧠 AI chapter guidance now better explains preview-sensitive azd ai behavior, tenant-specific login, current extension usage, and updated model deployment recommendations
  • 🧪 Workshop instructions now use more realistic version examples and clearer environment setup language for hands-on labs
  • 📈 Production and troubleshooting docs now align better with current monitoring, fallback model, and cost-tier examples

Files Updated

  • docs/chapter-01-foundation/README.md
  • docs/chapter-01-foundation/azd-basics.md
  • docs/chapter-01-foundation/installation.md
  • docs/chapter-02-ai-development/README.md
  • docs/chapter-02-ai-development/agents.md
  • docs/chapter-02-ai-development/ai-model-deployment.md
  • docs/chapter-02-ai-development/ai-workshop-lab.md
  • docs/chapter-02-ai-development/microsoft-foundry-integration.md
  • docs/chapter-03-configuration/README.md
  • docs/chapter-03-configuration/configuration.md
  • docs/chapter-04-infrastructure/README.md
  • docs/chapter-04-infrastructure/deployment-guide.md
  • docs/chapter-04-infrastructure/provisioning.md
  • docs/chapter-05-multi-agent/README.md
  • docs/chapter-06-pre-deployment/README.md
  • docs/chapter-06-pre-deployment/preflight-checks.md
  • docs/chapter-07-troubleshooting/README.md
  • docs/chapter-07-troubleshooting/ai-troubleshooting.md
  • docs/chapter-07-troubleshooting/common-issues.md
  • docs/chapter-08-production/README.md
  • docs/chapter-08-production/production-ai-practices.md
  • workshop/README.md
  • workshop/docs/index.md
  • workshop/docs/instructions/1-Select-AI-Template.md
  • workshop/docs/instructions/2-Validate-AI-Template.md
  • workshop/docs/instructions/3-Deconstruct-AI-Template.md
  • workshop/docs/instructions/5-Customize-AI-Template.md

[v3.18.0] - 2026-03-16

AZD AI CLI Commands, Content Validation & Template Expansion

This version adds azd ai, azd extension, and azd mcp command coverage across all AI-related chapters, fixes broken links and deprecated code in agents.md, updates the cheat sheet, and overhauls the Example Templates section with validated descriptions and new Azure AI AZD templates.

Added

  • 🤖 AZD AI CLI coverage across 7 files (previously only in Chapter 8):
    • docs/chapter-01-foundation/azd-basics.md — New "Extensions and AI Commands" section introducing azd extension, azd ai agent init, and azd mcp
    • docs/chapter-02-ai-development/agents.md — Option 4: azd ai agent init with comparison table (template vs manifest approach)
    • docs/chapter-02-ai-development/microsoft-foundry-integration.md — "AZD Extensions for Foundry" and "Agent-First Deployment" subsections
    • docs/chapter-05-multi-agent/README.md — Quick Start now shows both template and manifest-based deployment paths
    • docs/chapter-06-pre-deployment/coordination-patterns.md — Deploy section now includes azd ai agent init option
    • docs/chapter-07-troubleshooting/ai-troubleshooting.md — "AZD AI Extension Commands for Diagnostics" subsection
    • resources/cheat-sheet.md — New "AI & Extensions Commands" section with azd extension, azd ai agent init, azd mcp, and azd infra generate
  • 📦 New AZD AI example templates in microsoft-foundry-integration.md:
    • azure-search-openai-demo-csharp — .NET RAG chat with Blazor WebAssembly, Semantic Kernel, and voice chat support
    • azure-search-openai-demo-java — Java RAG chat using Langchain4J with ACA/AKS deployment options
    • contoso-creative-writer — Multi-agent creative writing app using Azure AI Agent Service, Bing Grounding, and Prompty
    • serverless-chat-langchainjs — Serverless RAG using Azure Functions + LangChain.js + Cosmos DB with Ollama local dev support
    • chat-with-your-data-solution-accelerator — Enterprise RAG accelerator with admin portal, Teams integration, and PostgreSQL/Cosmos DB options
    • azure-ai-travel-agents — Multi-agent MCP orchestration reference app with servers in .NET, Python, Java, and TypeScript
    • azd-ai-starter — Minimal Azure AI infrastructure Bicep starter template
    • 🔗 Awesome AZD AI Gallery link — Reference to the awesome-azd AI gallery (80+ templates)

Fixed

  • 🔗 agents.md navigation: Previous/Next links now match Chapter 2 README lesson order (Microsoft Foundry Integration → Agents → AI Model Deployment)
  • 🔗 agents.md broken links: production-ai-practices.md corrected to ../chapter-08-production/production-ai-practices.md (3 occurrences)
  • 📦 agents.md deprecated code: Replaced opencensus with azure-monitor-opentelemetry + OpenTelemetry SDK
  • 🐛 agents.md invalid API: Moved max_tokens from create_agent() to create_run() as max_completion_tokens
  • 🔢 agents.md token counting: Replaced rough len//4 estimate with tiktoken.encoding_for_model()
  • azure-search-openai-demo: Corrected services from "Cognitive Search + App Service" to "Azure AI Search + Azure Container Apps" (default host changed Oct 2024)
  • contoso-chat: Updated description to reference Azure AI Foundry + Prompty, matching the repo's actual title and tech stack

Removed

  • ai-document-processing: Removed non-functional template reference (repo not publicly accessible as an AZD template)

Improved

  • 📝 agents.md exercises: Exercise 1 now shows expected output and azd monitor step; Exercise 2 includes full FunctionTool registration code; Exercise 3 replaces vague guidance with concrete prepdocs.py commands
  • 📚 agents.md resources: Updated documentation links to current Azure AI Agent Service docs and quickstart
  • 📋 agents.md Next Steps table: Added AI Workshop Lab link for complete chapter coverage

Files Updated

  • docs/chapter-01-foundation/azd-basics.md
  • docs/chapter-02-ai-development/agents.md
  • docs/chapter-02-ai-development/microsoft-foundry-integration.md
  • docs/chapter-05-multi-agent/README.md
  • docs/chapter-06-pre-deployment/coordination-patterns.md
  • docs/chapter-07-troubleshooting/ai-troubleshooting.md
  • resources/cheat-sheet.md

[v3.17.0] - 2026-02-05

Course Navigation Enhancement

This version improves README.md chapter navigation with an enhanced table format.

Changed

  • Course Map Table: Enhanced with direct lesson links, duration estimates, and complexity ratings
  • Folder Cleanup: Removed redundant old folders (deployment/, getting-started/, pre-deployment/, troubleshooting/)
  • Link Validation: All 21+ internal links in Course Map table verified

[v3.16.0] - 2026-02-05

Product Name Updates

This version updates product references to current Microsoft branding.

Changed

  • Microsoft Foundry → Microsoft Foundry: All references updated across non-translation files
  • Azure AI Agent Service → Foundry Agents: Service name updated to reflect current branding

Files Updated

  • README.md - Main course landing page
  • changelog.md - Version history
  • course-outline.md - Course structure
  • docs/chapter-02-ai-development/agents.md - AI agents guide
  • examples/README.md - Examples documentation
  • workshop/README.md - Workshop landing page
  • workshop/docs/index.md - Workshop index
  • workshop/docs/instructions/*.md - All workshop instruction files

[v3.15.0] - 2026-02-05

Major Repository Restructuring: Chapter-Based Folder Names

This version restructures the documentation into dedicated chapter folders for clearer navigation.

Folder Renames

Old folders have been replaced with chapter-numbered folders:

  • docs/getting-started/docs/chapter-01-foundation/ + docs/chapter-03-configuration/
  • docs/microsoft-foundry/docs/chapter-02-ai-development/ + docs/chapter-08-production/
  • docs/deployment/docs/chapter-04-infrastructure/
  • docs/pre-deployment/docs/chapter-06-pre-deployment/
  • docs/troubleshooting/docs/chapter-07-troubleshooting/
  • Added new: docs/chapter-05-multi-agent/

File Migrations

File From To
azd-basics.md getting-started/ chapter-01-foundation/
installation.md getting-started/ chapter-01-foundation/
first-project.md getting-started/ chapter-01-foundation/
configuration.md getting-started/ chapter-03-configuration/
authsecurity.md getting-started/ chapter-03-configuration/
microsoft-foundry-integration.md microsoft-foundry/ chapter-02-ai-development/
agents.md microsoft-foundry/ chapter-02-ai-development/
ai-model-deployment.md microsoft-foundry/ chapter-02-ai-development/
ai-workshop-lab.md microsoft-foundry/ chapter-02-ai-development/
production-ai-practices.md microsoft-foundry/ chapter-08-production/
deployment-guide.md deployment/ chapter-04-infrastructure/
provisioning.md deployment/ chapter-04-infrastructure/
All pre-deployment files pre-deployment/ chapter-06-pre-deployment/
All troubleshooting files troubleshooting/ chapter-07-troubleshooting/

Added

  • 📚 Chapter README files: Created README.md in each chapter folder with:
    • Learning objectives and duration
    • Lesson table with descriptions
    • Quick start commands
    • Navigation to other chapters

Changed

  • 🔗 Updated all internal links: 78+ paths updated across all documentation files
  • 🗺️ Main README.md: Updated Course Map with new chapter structure
  • 📝 examples/README.md: Updated cross-references to chapter folders

Removed

  • Old folder structure (getting-started/, microsoft-foundry/, deployment/, pre-deployment/, troubleshooting/, ai-foundry/)

[v3.14.0] - 2026-02-05

Repository Restructuring: Chapter Navigation

This version added chapter navigation README files (superseded by v3.15.0).


[v3.13.0] - 2026-02-05

New AI Agents Guide

This version adds a comprehensive guide for deploying AI agents with Azure Developer CLI.

Added

  • 🤖 docs/microsoft-foundry/agents.md: Complete guide covering:
    • What AI agents are and how they differ from chatbots
    • Three quick-start agent templates (Foundry Agents, Prompty, RAG)
    • Agent architecture patterns (single agent, RAG, multi-agent)
    • Tool configuration and customization
    • Monitoring and metrics tracking
    • Cost considerations and optimization
    • Common troubleshooting scenarios
    • Three hands-on exercises with success criteria

Content Structure

  • Introduction: Agent concepts for beginners
  • Quick Start: Deploy agents with azd init --template get-started-with-ai-agents
  • Architecture Patterns: Visual diagrams of agent patterns
  • Configuration: Tool setup and environment variables
  • Monitoring: Application Insights integration
  • Exercises: Progressive hands-on learning (20-45 minutes each)

[v3.12.0] - 2026-02-05

DevContainer Environment Update

This version updates the development container configuration with modern tools and better defaults for the AZD learning experience.

Changed

  • 🐳 Base Image: Updated from python:3.12-bullseye to python:3.12-bookworm (latest Debian stable)
  • 📛 Container Name: Renamed from "Python 3" to "AZD for Beginners" for clarity

Added

  • 🔧 New Dev Container Features:

    • azure-cli with Bicep support enabled
    • node:20 (LTS version for AZD templates)
    • github-cli for template management
    • docker-in-docker for container app deployments
  • 🔌 Port Forwarding: Pre-configured ports for common development:

    • 8000 (MkDocs preview)
    • 3000 (Web apps)
    • 5000 (Python Flask)
    • 8080 (APIs)
  • 🧩 New VS Code Extensions:

    • ms-python.vscode-pylance - Enhanced Python IntelliSense
    • ms-azuretools.vscode-azurefunctions - Azure Functions support
    • ms-azuretools.vscode-docker - Docker support
    • ms-azuretools.vscode-bicep - Bicep language support
    • ms-azure-devtools.azure-resource-groups - Azure resource management
    • yzhang.markdown-all-in-one - Markdown editing
    • DavidAnson.vscode-markdownlint - Markdown linting
    • bierner.markdown-mermaid - Mermaid diagram support
    • redhat.vscode-yaml - YAML support (for azure.yaml)
    • eamodio.gitlens - Git visualization
    • mhutchie.git-graph - Git history
  • ⚙️ VS Code Settings: Added default settings for Python interpreter, format on save, and whitespace trimming

  • 📦 Updated requirements-dev.txt:

    • Added MkDocs minify plugin
    • Added pre-commit for code quality
    • Added Azure SDK packages (azure-identity, azure-mgmt-resource)

Fixed

  • Post-Create Command: Now verifies AZD and Azure CLI installation on container start

[v3.11.0] - 2026-02-05

Beginner-Friendly README Overhaul

This version significantly improves the README.md to be more accessible for beginners and adds essential resources for AI developers.

Added

  • 🆚 Azure CLI vs AZD Comparison: Clear explanation of when to use each tool with practical examples
  • 🌟 Awesome AZD Links: Direct links to community template gallery and contribution resources:
  • 🎯 Quick Start Guide: Simplified 3-step getting started section (Install → Login → Deploy)
  • 📊 Experience-Based Navigation Table: Clear guidance on where to start based on developer experience

Changed

  • README Structure: Reorganized for progressive disclosure - key information first
  • Introduction Section: Rewrote to explain "The Magic of azd up" for complete beginners
  • Removed Duplicate Content: Eliminated duplicate troubleshooting section
  • Troubleshooting Commands: Fixed azd logs reference to use valid azd monitor --logs

Fixed

  • 🔐 Authentication Commands: Added azd auth login and azd auth logout to cheat-sheet.md
  • Invalid Command References: Removed remaining azd logs from README troubleshooting section

Notes

  • Scope: Changes applied to main README.md and resources/cheat-sheet.md
  • Target Audience: Improvements specifically aimed at developers new to AZD

[v3.10.0] - 2026-02-05

Azure Developer CLI Command Accuracy Update

This version corrects non-existent AZD commands throughout the documentation, ensuring all code examples use valid Azure Developer CLI syntax.

Fixed

  • 🔧 Non-Existent AZD Commands Removed: Comprehensive audit and correction of invalid commands:

    • azd logs (doesn't exist) → replaced with azd monitor --logs or Azure CLI alternatives
    • azd service subcommands (don't exist) → replaced with azd show and Azure CLI
    • azd infra import/export/validate (don't exist) → removed or replaced with valid alternatives
    • azd deploy --rollback/--incremental/--parallel/--detect-changes flags (don't exist) → removed
    • azd provision --what-if/--rollback flags (don't exist) → updated to use --preview
    • azd config validate (doesn't exist) → replaced with azd config list
    • azd info, azd history, azd metrics (don't exist) → removed
  • 📚 Files Updated with Command Corrections:

    • resources/cheat-sheet.md: Major overhaul of command reference
    • docs/deployment/deployment-guide.md: Fixed rollback and deployment strategies
    • docs/troubleshooting/debugging.md: Corrected log analysis sections
    • docs/troubleshooting/common-issues.md: Updated troubleshooting commands
    • docs/troubleshooting/ai-troubleshooting.md: Fixed AZD debugging section
    • docs/getting-started/azd-basics.md: Corrected monitoring commands
    • docs/getting-started/first-project.md: Updated monitoring and debugging examples
    • docs/getting-started/installation.md: Fixed help and version examples
    • docs/pre-deployment/application-insights.md: Corrected log viewing commands
    • docs/pre-deployment/coordination-patterns.md: Fixed agent debugging commands
  • 📝 Version Reference Updated:

    • docs/getting-started/installation.md: Changed hardcoded 1.5.0 version to generic 1.x.x with link to releases

Changed

  • Rollback Strategies: Updated documentation to use Git-based rollback (AZD doesn't have native rollback)
  • Log Viewing: Replaced azd logs references with azd monitor --logs, azd monitor --live, and Azure CLI commands
  • Performance Section: Removed non-existent parallel/incremental deployment flags, provided valid alternatives

Technical Details

  • Valid AZD Commands: init, up, auth, deploy, down, provision, publish, completion, config, env, show, version, monitor
  • Valid azd monitor Flags: --live, --logs, --overview
  • Removed Features: azd logs, azd service, azd infra import/export/validate, azd history, azd metrics, azd info, azd config validate

Notes

  • Verification: Commands validated against Azure Developer CLI v1.23.x

[v3.9.0] - 2026-02-05

Workshop Completion and Documentation Quality Update

This version completes the interactive workshop modules, fixes all broken documentation links, and improves overall content quality for AI developers using Microsoft AZD.

Added

  • 📝 CONTRIBUTING.md: New contribution guidelines document with:
    • Clear instructions for reporting issues and proposing changes
    • Documentation standards for new content
    • Code example guidelines and commit message conventions
    • Community engagement information

Completed

  • 🎯 Workshop Module 7 (Wrap-up): Fully completed wrap-up module with:

    • Comprehensive summary of workshop accomplishments
    • Key concepts mastered section covering AZD, templates, and Microsoft Foundry
    • Learning journey continuation recommendations
    • Workshop challenge exercises with difficulty ratings
    • Community feedback and support links
  • 📚 Workshop Module 3 (Deconstruct): Updated learning objectives with:

    • GitHub Copilot with MCP servers activation guidance
    • AZD template folder structure understanding
    • Infrastructure-as-code (Bicep) organization patterns
    • Hands-on lab instructions
  • 🔧 Workshop Module 6 (Teardown): Completed with:

    • Resource cleanup and cost management objectives
    • azd down usage for safe infrastructure deprovisioning
    • Soft-deleted cognitive services recovery guidance
    • Bonus exploration prompts for GitHub Copilot and Azure Portal

Fixed

  • 🔗 Broken Link Fixes: Resolved 15+ broken internal documentation links:

    • docs/ai-foundry/ai-model-deployment.md: Fixed paths to microsoft-foundry-integration.md
    • docs/troubleshooting/ai-troubleshooting.md: Corrected ai-model-deployment.md and production-ai-practices.md paths
    • docs/getting-started/first-project.md: Replaced non-existent cicd-integration.md with deployment-guide.md
    • examples/retail-scenario.md: Fixed FAQ and troubleshooting guide paths
    • examples/container-app/microservices/README.md: Corrected course home and deployment guide paths
    • resources/faq.md and resources/glossary.md: Updated AI chapter references
    • course-outline.md: Fixed instructor guide and AI workshop lab references
  • 📅 Workshop Status Banner: Updated from "Under Construction" to active workshop status with February 2026 date

  • 🔗 Workshop Navigation: Fixed broken navigation links in workshop README.md pointing to non-existent lab-1-azd-basics folder

Changed

  • Workshop Presentation: Removed "under construction" warning, workshop is now complete and ready for use
  • Navigation Consistency: Ensured all workshop modules have proper inter-module navigation
  • Learning Path References: Updated chapter cross-references to use correct microsoft-foundry paths

Validated

  • ✅ All English markdown files have valid internal links
  • ✅ Workshop modules 0-7 are complete with learning objectives
  • ✅ Navigation between chapters and modules functions correctly
  • ✅ Content is suitable for AI developers using Microsoft AZD
  • ✅ Beginner-friendly language and structure maintained throughout
  • ✅ CONTRIBUTING.md provides clear guidance for community contributors

Technical Implementation

  • Link Validation: Automated PowerShell script verified all .md internal links
  • Content Audit: Manual review of workshop completeness and beginner suitability
  • Navigation System: Consistent chapter and module navigation patterns applied

Notes

  • Scope: Changes applied to English documentation only
  • Translations: Translation folders not updated in this version (automated translation will sync later)
  • Workshop Duration: Complete workshop now provides 3-4 hours of hands-on learning

[v3.8.0] - 2025-11-19

Advanced Documentation: Monitoring, Security, and Multi-Agent Patterns

This version adds comprehensive A-grade lessons on Application Insights integration, authentication patterns, and multi-agent coordination for production deployments.

Added

  • 📊 Application Insights Integration Lesson: in docs/pre-deployment/application-insights.md:

    • AZD-focused deployment with automatic provisioning
    • Complete Bicep templates for Application Insights + Log Analytics
    • Working Python applications with custom telemetry (1,200+ lines)
    • AI/LLM monitoring patterns (Microsoft Foundry Models token/cost tracking)
    • 6 Mermaid diagrams (architecture, distributed tracing, telemetry flow)
    • 3 hands-on exercises (alerts, dashboards, AI monitoring)
    • Kusto query examples and cost optimization strategies
    • Live metrics streaming and real-time debugging
    • 40-50 minute learning time with production-ready patterns
  • 🔐 Authentication & Security Patterns Lesson: in docs/getting-started/authsecurity.md:

    • 3 authentication patterns (connection strings, Key Vault, managed identity)
    • Complete Bicep infrastructure templates for secure deployments
    • Node.js application code with Azure SDK integration
    • 3 complete exercises (enable managed identity, user-assigned identity, Key Vault rotation)
    • Security best practices and RBAC configurations
    • Troubleshooting guide and cost analysis
    • Production-ready passwordless authentication patterns
  • 🤖 Multi-Agent Coordination Patterns Lesson: in docs/pre-deployment/coordination-patterns.md:

    • 5 coordination patterns (sequential, parallel, hierarchical, event-driven, consensus)
    • Complete orchestrator service implementation (Python/Flask, 1,500+ lines)
    • 3 specialized agent implementations (Research, Writer, Editor)
    • Service Bus integration for message queuing
    • Cosmos DB state management for distributed systems
    • 6 Mermaid diagrams showing agent interactions
    • 3 advanced exercises (timeout handling, retry logic, circuit breaker)
    • Cost breakdown ($240-565/month) with optimization strategies
    • Application Insights integration for monitoring

Enhanced

  • Pre-deployment Chapter: Now includes comprehensive monitoring and coordination patterns
  • Getting Started Chapter: Enhanced with professional authentication patterns
  • Production Readiness: Complete coverage from security to observability
  • Course Outline: Updated to reference new lessons in Chapters 3 and 6

Changed

  • Learning Progression: Better integration of security and monitoring throughout course
  • Documentation Quality: Consistent A-grade standards (95-97%) across new lessons
  • Production Patterns: Complete end-to-end coverage for enterprise deployments

Improved

  • Developer Experience: Clear path from development to production monitoring
  • Security Standards: Professional patterns for authentication and secrets management
  • Observability: Complete Application Insights integration with AZD
  • AI Workloads: Specialized monitoring for Microsoft Foundry Models and multi-agent systems

Validated

  • ✅ All lessons include complete working code (not snippets)
  • ✅ Mermaid diagrams for visual learning (19 total across 3 lessons)
  • ✅ Hands-on exercises with verification steps (9 total)
  • ✅ Production-ready Bicep templates deployable via azd up
  • ✅ Cost analysis and optimization strategies
  • ✅ Troubleshooting guides and best practices
  • ✅ Knowledge checkpoints with verification commands

Documentation Grading Results

  • docs/pre-deployment/application-insights.md: - Comprehensive monitoring guide
  • docs/getting-started/authsecurity.md: - Professional security patterns
  • docs/pre-deployment/coordination-patterns.md: - Advanced multi-agent architectures
  • Overall New Content: - Consistent high-quality standards

Technical Implementation

  • Application Insights: Log Analytics + custom telemetry + distributed tracing
  • Authentication: Managed Identity + Key Vault + RBAC patterns
  • Multi-Agent: Service Bus + Cosmos DB + Container Apps + orchestration
  • Monitoring: Live metrics + Kusto queries + alerts + dashboards
  • Cost Management: Sampling strategies, retention policies, budget controls

[v3.7.0] - 2025-11-19

Documentation Quality Improvements and New Microsoft Foundry Models Example

This version enhances documentation quality across the repository and adds a complete Microsoft Foundry Models deployment example with gpt-4.1 chat interface.

Added

  • 🤖 Microsoft Foundry Models Chat Example: Complete gpt-4.1 deployment with working implementation in examples/azure-openai-chat/:
    • Complete Microsoft Foundry Models infrastructure (gpt-4.1 model deployment)
    • Python command-line chat interface with conversation history
    • Key Vault integration for secure API key storage
    • Token usage tracking and cost estimation
    • Rate limiting and error handling
    • Comprehensive README with 35-45 minute deployment guide
    • 11 production-ready files (Bicep templates, Python app, configuration)
  • 📚 Documentation Exercises: Added hands-on practice exercises to configuration guide:
    • Exercise 1: Multi-environment configuration (15 minutes)
    • Exercise 2: Secret management practice (10 minutes)
    • Clear success criteria and verification steps
  • ✅ Deployment Verification: Added verification section to deployment guide:
    • Health check procedures
    • Success criteria checklist
    • Expected outputs for all deployment commands
    • Troubleshooting quick reference

Enhanced

  • examples/README.md: Updated to A-grade quality (93%):
    • Added azure-openai-chat to all relevant sections
    • Updated local example count from 3 to 4
    • Added to AI Application Examples table
    • Integrated into Quick Start for Intermediate Users
    • Added to Microsoft Foundry Templates section
    • Updated Comparison Matrix and technology finding sections
  • Documentation Quality: Improved B+ (87%) → A- (92%) across docs folder:
    • Added expected outputs to critical command examples
    • Included verification steps for configuration changes
    • Enhanced hands-on learning with practical exercises

Changed

  • Learning Progression: Better integration of AI examples for intermediate learners
  • Documentation Structure: More actionable exercises with clear outcomes
  • Verification Process: Explicit success criteria added to key workflows

Improved

  • Developer Experience: Microsoft Foundry Models deployment now takes 35-45 minutes (vs 60-90 for complex alternatives)
  • Cost Transparency: Clear cost estimates ($50-200/month) for Microsoft Foundry Models example
  • Learning Path: AI developers have clear entry point with azure-openai-chat
  • Documentation Standards: Consistent expected outputs and verification steps

Validated

  • ✅ Microsoft Foundry Models example fully functional with azd up
  • ✅ All 11 implementation files syntactically correct
  • ✅ README instructions match actual deployment experience
  • ✅ Documentation links updated across 8+ locations
  • ✅ Examples index accurately reflects 4 local examples
  • ✅ No duplicate external links in tables
  • ✅ All navigation references correct

Technical Implementation

  • Microsoft Foundry Models Architecture: gpt-4.1 + Key Vault + Container Apps pattern
  • Security: Managed Identity ready, secrets in Key Vault
  • Monitoring: Application Insights integration
  • Cost Management: Token tracking and usage optimization
  • Deployment: Single azd up command for complete setup

[v3.6.0] - 2025-11-19

Major Update: Container App Deployment Examples

This version introduces comprehensive, production-ready container application deployment examples using Azure Developer CLI (AZD), with full documentation and integration into the learning path.

Added

  • 🚀 Container App Examples: New local examples in examples/container-app/:
    • Master Guide: Complete overview of containerized deployments, quick start, production, and advanced patterns
    • Simple Flask API: Beginner-friendly REST API with scale-to-zero, health probes, monitoring, and troubleshooting
    • Microservices Architecture: Production-ready multi-service deployment (API Gateway, Product, Order, User, Notification), async messaging, Service Bus, Cosmos DB, Azure SQL, distributed tracing, blue-green/canary deployment
  • Best Practices: Security, monitoring, cost optimization, and CI/CD guidance for containerized workloads
  • Code Samples: Complete azure.yaml, Bicep templates, and multi-language service implementations (Python, Node.js, C#, Go)
  • Testing & Troubleshooting: End-to-end test scenarios, monitoring commands, troubleshooting guidance

Changed

  • README.md: Updated to feature and link new container app examples under "Local Examples - Container Applications"
  • examples/README.md: Updated to highlight container app examples, add comparison matrix entries, and update technology/architecture references
  • Course Outline & Study Guide: Updated to reference new container app examples and deployment patterns in relevant chapters

Validated

  • ✅ All new examples deployable with azd up and follow best practices
  • ✅ Documentation cross-links and navigation updated
  • ✅ Examples cover beginner to advanced scenarios, including production microservices

Notes

  • Scope: English documentation and examples only
  • Next Steps: Expand with additional advanced container patterns and CI/CD automation in future releases

[v3.5.0] - 2025-11-19

Product Rebranding: Microsoft Foundry

This version implements a comprehensive product name change from "Microsoft Foundry" to "Microsoft Foundry" across all English documentation, reflecting Microsoft's official rebranding.

Changed

  • 🔄 Product Name Update: Complete rebranding from "Microsoft Foundry" to "Microsoft Foundry"

    • Updated all references across English documentation in docs/ folder
    • Renamed folder: docs/ai-foundry/docs/microsoft-foundry/
    • Renamed file: azure-ai-foundry-integration.mdmicrosoft-foundry-integration.md
    • Total: 23 content references updated across 7 documentation files
  • 📁 Folder Structure Changes:

    • docs/ai-foundry/ renamed to docs/microsoft-foundry/
    • All cross-references updated to reflect new folder structure
    • Navigation links validated across all documentation
  • 📄 File Renames:

    • azure-ai-foundry-integration.mdmicrosoft-foundry-integration.md
    • All internal links updated to reference new filename

Updated Files

  • Chapter Documentation (7 files):

    • docs/microsoft-foundry/ai-model-deployment.md - 3 navigation link updates
    • docs/microsoft-foundry/ai-workshop-lab.md - 4 product name references updated
    • docs/microsoft-foundry/microsoft-foundry-integration.md - Already using Microsoft Foundry (from previous updates)
    • docs/microsoft-foundry/production-ai-practices.md - 3 references updated (overview, community feedback, documentation)
    • docs/getting-started/azd-basics.md - 4 cross-reference links updated
    • docs/getting-started/first-project.md - 2 chapter navigation links updated
    • docs/getting-started/installation.md - 2 next chapter links updated
    • docs/troubleshooting/ai-troubleshooting.md - 3 references updated (navigation, Discord community)
    • docs/troubleshooting/common-issues.md - 1 navigation link updated
    • docs/troubleshooting/debugging.md - 1 navigation link updated
  • Course Structure Files (2 files):

    • README.md - 17 references updated (course overview, chapter titles, templates section, community insights)
    • course-outline.md - 14 references updated (overview, learning objectives, chapter resources)

Validated

  • ✅ Zero remaining "ai-foundry" folder path references in English docs
  • ✅ Zero remaining "Microsoft Foundry" product name references in English docs
  • ✅ All navigation links functional with new folder structure
  • ✅ File and folder renames completed successfully
  • ✅ Cross-references between chapters validated

Notes

  • Scope: Changes applied to English documentation in docs/ folder only
  • Translations: Translation folders (translations/) not updated in this version
  • Workshop: Workshop materials (workshop/) not updated in this version
  • Examples: Example files may still reference legacy naming (to be addressed in future update)
  • External Links: External URLs and GitHub repository references remain unchanged

Migration Guide for Contributors

If you have local branches or documentation referencing the old structure:

  1. Update folder references: docs/ai-foundry/docs/microsoft-foundry/
  2. Update file references: azure-ai-foundry-integration.mdmicrosoft-foundry-integration.md
  3. Replace product name: "Microsoft Foundry" → "Microsoft Foundry"
  4. Validate all internal documentation links still work

[v3.4.0] - 2025-10-24

Infrastructure Preview and Validation Enhancements

This version introduces comprehensive support for the new Azure Developer CLI preview feature and enhances workshop user experience.

Added

  • 🧪 azd provision --preview Feature Documentation: Comprehensive coverage of the new infrastructure preview capability
    • Command reference and usage examples in cheat sheet
    • Detailed integration in provisioning guide with use cases and benefits
    • Pre-flight check integration for safer deployment validation
    • Getting started guide updates with safety-first deployment practices
  • 🚧 Workshop Status Banner: Professional HTML banner indicating workshop development status
    • Gradient design with construction indicators for clear user communication
    • Last updated timestamp for transparency
    • Mobile-responsive design for all device types

Enhanced

  • Infrastructure Safety: Preview functionality integrated throughout deployment documentation
  • Pre-deployment Validation: Automated scripts now include infrastructure preview testing
  • Developer Workflow: Updated command sequences to include preview as best practice
  • Workshop Experience: Clear expectations set for users about content development status

Changed

  • Deployment Best Practices: Preview-first workflow now recommended approach
  • Documentation Flow: Infrastructure validation moved earlier in learning process
  • Workshop Presentation: Professional status communication with clear development timeline

Improved

  • Safety-First Approach: Infrastructure changes can now be validated before deployment
  • Team Collaboration: Preview results can be shared for review and approval
  • Cost Awareness: Better understanding of resource costs before provisioning
  • Risk Mitigation: Reduced deployment failures through advance validation

Technical Implementation

  • Multi-document Integration: Preview feature documented across 4 key files
  • Command Patterns: Consistent syntax and examples throughout documentation
  • Best Practice Integration: Preview included in validation workflows and scripts
  • Visual Indicators: Clear NEW feature markings for discoverability

Workshop Infrastructure

  • Status Communication: Professional HTML banner with gradient styling
  • User Experience: Clear development status prevents confusion
  • Professional Presentation: Maintains repository credibility while setting expectations
  • Timeline Transparency: October 2025 last updated timestamp for accountability

[v3.3.0] - 2025-09-24

Enhanced Workshop Materials and Interactive Learning Experience

This version introduces comprehensive workshop materials with browser-based interactive guides and structured learning paths.

Added

  • 🎥 Interactive Workshop Guide: Browser-based workshop experience with MkDocs preview capability
  • 📝 Structured Workshop Instructions: 7-step guided learning path from discovery to customization
    • 0-Introduction: Workshop overview and setup
    • 1-Select-AI-Template: Template discovery and selection process
    • 2-Validate-AI-Template: Deployment and validation procedures
    • 3-Deconstruct-AI-Template: Understanding template architecture
    • 4-Configure-AI-Template: Configuration and customization
    • 5-Customize-AI-Template: Advanced modifications and iterations
    • 6-Teardown-Infrastructure: Cleanup and resource management
    • 7-Wrap-up: Summary and next steps
  • 🛠️ Workshop Tooling: MkDocs configuration with Material theme for enhanced learning experience
  • 🎯 Hands-On Learning Path: 3-step methodology (Discovery → Deployment → Customization)
  • 📱 GitHub Codespaces Integration: Seamless development environment setup

Enhanced

  • AI Workshop Lab: Extended with comprehensive 2-3 hour structured learning experience
  • Workshop Documentation: Professional presentation with navigation and visual aids
  • Learning Progression: Clear step-by-step guidance from template selection to production deployment
  • Developer Experience: Integrated tooling for streamlined development workflows

Improved

  • Accessibility: Browser-based interface with search, copy functionality, and theme toggle
  • Self-Paced Learning: Flexible workshop structure accommodating different learning speeds
  • Practical Application: Real-world AI template deployment scenarios
  • Community Integration: Discord integration for workshop support and collaboration

Workshop Features

  • Built-in Search: Quick keyword and lesson discovery
  • Copy Code Blocks: Hover-to-copy functionality for all code examples
  • Theme Toggle: Dark/light mode support for different preferences
  • Visual Assets: Screenshots and diagrams for enhanced understanding
  • Help Integration: Direct Discord access for community support

[v3.2.0] - 2025-09-17

Major Navigation Restructuring and Chapter-Based Learning System

This version introduces a comprehensive chapter-based learning structure with enhanced navigation throughout the entire repository.

Added

  • 📚 Chapter-Based Learning System: Restructured entire course into 8 progressive learning chapters
    • Chapter 1: Foundation & Quick Start (⭐ - 30-45 mins)
    • Chapter 2: AI-First Development (⭐⭐ - 1-2 hours)
    • Chapter 3: Configuration & Authentication (⭐⭐ - 45-60 mins)
    • Chapter 4: Infrastructure as Code & Deployment (⭐⭐⭐ - 1-1.5 hours)
    • Chapter 5: Multi-Agent AI Solutions (⭐⭐⭐⭐ - 2-3 hours)
    • Chapter 6: Pre-Deployment Validation & Planning (⭐⭐ - 1 hour)
    • Chapter 7: Troubleshooting & Debugging (⭐⭐ - 1-1.5 hours)
    • Chapter 8: Production & Enterprise Patterns (⭐⭐⭐⭐ - 2-3 hours)
  • 📚 Comprehensive Navigation System: Consistent navigation headers and footers across all documentation
  • 🎯 Progress Tracking: Course completion checklist and learning verification system
  • 🗺️ Learning Path Guidance: Clear entry points for different experience levels and goals
  • 🔗 Cross-Reference Navigation: Related chapters and prerequisites clearly linked

Enhanced

  • README Structure: Transformed into a structured learning platform with chapter-based organization
  • Documentation Navigation: Every page now includes chapter context and progression guidance
  • Template Organization: Examples and templates mapped to appropriate learning chapters
  • Resource Integration: Cheat sheets, FAQs, and study guides connected to relevant chapters
  • Workshop Integration: Hands-on labs mapped to multiple chapter learning objectives

Changed

  • Learning Progression: Moved from linear documentation to flexible chapter-based learning
  • Configuration Placement: Repositioned configuration guide as Chapter 3 for better learning flow
  • AI Content Integration: Better integration of AI-specific content throughout the learning journey
  • Production Content: Advanced patterns consolidated in Chapter 8 for enterprise learners

Improved

  • User Experience: Clear navigation breadcrumbs and chapter progression indicators
  • Accessibility: Consistent navigation patterns for easier course traversal
  • Professional Presentation: University-style course structure suitable for academic and corporate training
  • Learning Efficiency: Reduced time to find relevant content through improved organization

Technical Implementation

  • Navigation Headers: Standardized chapter navigation across 40+ documentation files
  • Footer Navigation: Consistent progression guidance and chapter completion indicators
  • Cross-Linking: Comprehensive internal linking system connecting related concepts
  • Chapter Mapping: Templates and examples clearly associated with learning objectives

Study Guide Enhancement

  • 📚 Comprehensive Learning Objectives: Restructured study guide to align with 8-chapter system
  • 🎯 Chapter-Based Assessment: Each chapter includes specific learning objectives and practical exercises
  • 📋 Progress Tracking: Weekly learning schedule with measurable outcomes and completion checklists
  • ❓ Assessment Questions: Knowledge validation questions for each chapter with professional outcomes
  • 🛠️ Practical Exercises: Hands-on activities with real deployment scenarios and troubleshooting
  • 📊 Skill Progression: Clear advancement from basic concepts to enterprise patterns with career development focus
  • 🎓 Certification Framework: Professional development outcomes and community recognition system
  • ⏱️ Timeline Management: Structured 10-week learning plan with milestone validation

[v3.1.0] - 2025-09-17

Enhanced Multi-Agent AI Solutions

This version improves the multi-agent retail solution with better agent naming and enhanced documentation.

Changed

  • Multi-Agent Terminology: Replaced "Cora agent" with "Customer agent" throughout retail multi-agent solution for clearer understanding
  • Agent Architecture: Updated all documentation, ARM templates, and code examples to use consistent "Customer agent" naming
  • Configuration Examples: Modernized agent configuration patterns with updated naming conventions
  • Documentation Consistency: Ensured all references use professional, descriptive agent names

Enhanced

  • ARM Template Package: Updated retail-multiagent-arm-template with Customer agent references
  • Architecture Diagrams: Refreshed Mermaid diagrams with updated agent naming
  • Code Examples: Python classes and implementation examples now use CustomerAgent naming
  • Environment Variables: Updated all deployment scripts to use CUSTOMER_AGENT_NAME conventions

Improved

  • Developer Experience: Clearer agent roles and responsibilities in documentation
  • Production Readiness: Better alignment with enterprise naming conventions
  • Learning Materials: More intuitive agent naming for educational purposes
  • Template Usability: Simplified understanding of agent functions and deployment patterns

Technical Details

  • Updated Mermaid architecture diagrams with CustomerAgent references
  • Replaced CoraAgent class names with CustomerAgent in Python examples
  • Modified ARM template JSON configurations to use "customer" agent type
  • Updated environment variables from CORA_AGENT_* to CUSTOMER_AGENT_* patterns
  • Refreshed all deployment commands and container configurations

[v3.0.0] - 2025-09-12

Major Changes - AI Developer Focus and Microsoft Foundry Integration

This version transforms the repository into a comprehensive AI-focused learning resource with Microsoft Foundry integration.

Added

  • 🤖 AI-First Learning Path: Complete restructure prioritizing AI developers and engineers
  • Microsoft Foundry Integration Guide: Comprehensive documentation for connecting AZD with Microsoft Foundry services
  • AI Model Deployment Patterns: Detailed guide covering model selection, configuration, and production deployment strategies
  • AI Workshop Lab: 2-3 hour hands-on workshop for converting AI applications to AZD-deployable solutions
  • Production AI Best Practices: Enterprise-ready patterns for scaling, monitoring, and securing AI workloads
  • AI-Specific Troubleshooting Guide: Comprehensive troubleshooting for Microsoft Foundry Models, Cognitive Services, and AI deployment issues
  • AI Template Gallery: Featured collection of Microsoft Foundry templates with complexity ratings
  • Workshop Materials: Complete workshop structure with hands-on labs and reference materials

Enhanced

  • README Structure: AI-developer focused with 45% community interest data from Microsoft Foundry Discord
  • Learning Paths: Dedicated AI developer journey alongside traditional paths for students and DevOps engineers
  • Template Recommendations: Featured AI templates including azure-search-openai-demo, contoso-chat, and openai-chat-app-quickstart
  • Community Integration: Enhanced Discord community support with AI-specific channels and discussions

Security & Production Focus

  • Managed Identity Patterns: AI-specific authentication and security configurations
  • Cost Optimization: Token usage tracking and budget controls for AI workloads
  • Multi-Region Deployment: Strategies for global AI application deployment
  • Performance Monitoring: AI-specific metrics and Application Insights integration

Documentation Quality

  • Linear Course Structure: Logical progression from beginner to advanced AI deployment patterns
  • Validated URLs: All external repository links verified and accessible
  • Complete Reference: All internal documentation links validated and functional
  • Production Ready: Enterprise deployment patterns with real-world examples

[v2.0.0] - 2025-09-09

Major Changes - Repository Restructure and Professional Enhancement

This version represents a significant overhaul of the repository structure and content presentation.

Added

  • Structured Learning Framework: All documentation pages now include Introduction, Learning Goals, and Learning Outcomes sections
  • Navigation System: Added Previous/Next lesson links throughout all documentation for guided learning progression
  • Study Guide: Comprehensive study-guide.md with learning objectives, practice exercises, and assessment materials
  • Professional Presentation: Removed all emoji icons for improved accessibility and professional appearance
  • Enhanced Content Structure: Improved organization and flow of learning materials

Changed

  • Documentation Format: Standardized all documentation with consistent learning-focused structure
  • Navigation Flow: Implemented logical progression through all learning materials
  • Content Presentation: Removed decorative elements in favor of clear, professional formatting
  • Link Structure: Updated all internal links to support new navigation system

Improved

  • Accessibility: Removed emoji dependencies for better screen reader compatibility
  • Professional Appearance: Clean, academic-style presentation suitable for enterprise learning
  • Learning Experience: Structured approach with clear objectives and outcomes for each lesson
  • Content Organization: Better logical flow and connection between related topics

[v1.0.0] - 2025-09-09

Initial Release - Comprehensive AZD Learning Repository

Added

  • Core Documentation Structure

    • Complete getting-started guide series
    • Comprehensive deployment and provisioning documentation
    • Detailed troubleshooting resources and debugging guides
    • Pre-deployment validation tools and procedures
  • Getting Started Module

    • AZD Basics: Core concepts and terminology
    • Installation Guide: Platform-specific setup instructions
    • Configuration Guide: Environment setup and authentication
    • First Project Tutorial: Step-by-step hands-on learning
  • Deployment and Provisioning Module

    • Deployment Guide: Complete workflow documentation
    • Provisioning Guide: Infrastructure as Code with Bicep
    • Best practices for production deployments
    • Multi-service architecture patterns
  • Pre-deployment Validation Module

    • Capacity Planning: Azure resource availability validation
    • SKU Selection: Comprehensive service tier guidance
    • Pre-flight Checks: Automated validation scripts (PowerShell and Bash)
    • Cost estimation and budget planning tools
  • Troubleshooting Module

    • Common Issues: Frequently encountered problems and solutions
    • Debugging Guide: Systematic troubleshooting methodologies
    • Advanced diagnostic techniques and tools
    • Performance monitoring and optimization
  • Resources and References

    • Command Cheat Sheet: Quick reference for essential commands
    • Glossary: Comprehensive terminology and acronym definitions
    • FAQ: Detailed answers to common questions
    • External resource links and community connections
  • Examples and Templates

    • Simple Web Application example
    • Static Website deployment template
    • Container Application configuration
    • Database integration patterns
    • Microservices architecture examples
    • Serverless function implementations

Features

  • Multi-Platform Support: Installation and configuration guides for Windows, macOS, and Linux
  • Multiple Skill Levels: Content designed for students through professional developers
  • Practical Focus: Hands-on examples and real-world scenarios
  • Comprehensive Coverage: From basic concepts to advanced enterprise patterns
  • Security-First Approach: Security best practices integrated throughout
  • Cost Optimization: Guidance for cost-effective deployments and resource management

Documentation Quality

  • Detailed Code Examples: Practical, tested code samples
  • Step-by-Step Instructions: Clear, actionable guidance
  • Comprehensive Error Handling: Troubleshooting for common issues
  • Best Practices Integration: Industry standards and recommendations
  • Version Compatibility: Up-to-date with latest Azure services and azd features

Planned Future Enhancements

Version 3.1.0 (Planned)

AI Platform Expansion

  • Multi-Model Support: Integration patterns for Hugging Face, Azure Machine Learning, and custom models
  • AI Agent Frameworks: Templates for LangChain, Semantic Kernel, and AutoGen deployments
  • Advanced RAG Patterns: Vector database options beyond Azure AI Search (Pinecone, Weaviate, etc.)
  • AI Observability: Enhanced monitoring for model performance, token usage, and response quality

Developer Experience

  • VS Code Extension: Integrated AZD + Microsoft Foundry development experience
  • GitHub Copilot Integration: AI-assisted AZD template generation
  • Interactive Tutorials: Hands-on coding exercises with automated validation for AI scenarios
  • Video Content: Supplementary video tutorials for visual learners focusing on AI deployments

Version 4.0.0 (Planned)

Enterprise AI Patterns

  • Governance Framework: AI model governance, compliance, and audit trails
  • Multi-Tenant AI: Patterns for serving multiple customers with isolated AI services
  • Edge AI Deployment: Integration with Azure IoT Edge and container instances
  • Hybrid Cloud AI: Multi-cloud and hybrid deployment patterns for AI workloads

Advanced Features

  • AI Pipeline Automation: MLOps integration with Azure Machine Learning pipelines
  • Advanced Security: Zero-trust patterns, private endpoints, and advanced threat protection
  • Performance Optimization: Advanced tuning and scaling strategies for high-throughput AI applications
  • Global Distribution: Content delivery and edge caching patterns for AI applications

Version 3.0.0 (Planned) - Superseded by Current Release

Proposed Additions - Now Implemented in v3.0.0

  • AI-Focused Content: Comprehensive Microsoft Foundry integration (Completed)
  • Interactive Tutorials: Hands-on AI workshop lab (Completed)
  • Advanced Security Module: AI-specific security patterns (Completed)
  • Performance Optimization: AI workload tuning strategies (Completed)

Version 2.1.0 (Planned) - Partially Implemented in v3.0.0

Minor Enhancements - Some Completed in Current Release

  • Additional Examples: AI-focused deployment scenarios (Completed)
  • Extended FAQ: AI-specific questions and troubleshooting (Completed)
  • Tool Integration: Enhanced IDE and editor integration guides
  • Monitoring Expansion: AI-specific monitoring and alerting patterns (Completed)

Still Planned for Future Release

  • Mobile-Friendly Documentation: Responsive design for mobile learning
  • Offline Access: Downloadable documentation packages
  • Enhanced IDE Integration: VS Code extension for AZD + AI workflows
  • Community Dashboard: Real-time community metrics and contribution tracking

Contributing to the Changelog

Reporting Changes

When contributing to this repository, please ensure changelog entries include:

  1. Version Number: Following semantic versioning (major.minor.patch)
  2. Date: Release or update date in YYYY-MM-DD format
  3. Category: Added, Changed, Deprecated, Removed, Fixed, Security
  4. Clear Description: Concise description of what changed
  5. Impact Assessment: How changes affect existing users

Change Categories

Added

  • New features, documentation sections, or capabilities
  • New examples, templates, or learning resources
  • Additional tools, scripts, or utilities

Changed

  • Modifications to existing functionality or documentation
  • Updates to improve clarity or accuracy
  • Restructuring of content or organization

Deprecated

  • Features or approaches that are being phased out
  • Documentation sections scheduled for removal
  • Methods that have better alternatives

Removed

  • Features, documentation, or examples that are no longer relevant
  • Outdated information or deprecated approaches
  • Redundant or consolidated content

Fixed

  • Corrections to errors in documentation or code
  • Resolution of reported issues or problems
  • Improvements to accuracy or functionality

Security

  • Security-related improvements or fixes
  • Updates to security best practices
  • Resolution of security vulnerabilities

Semantic Versioning Guidelines

Major Version (X.0.0)

  • Breaking changes that require user action
  • Significant restructuring of content or organization
  • Changes that alter the fundamental approach or methodology

Minor Version (X.Y.0)

  • New features or content additions
  • Enhancements that maintain backward compatibility
  • Additional examples, tools, or resources

Patch Version (X.Y.Z)

  • Bug fixes and corrections
  • Minor improvements to existing content
  • Clarifications and small enhancements

Community Feedback and Suggestions

We actively encourage community feedback to improve this learning resource:

How to Provide Feedback

  • GitHub Issues: Report problems or suggest improvements (AI-specific issues welcome)
  • Discord Discussions: Share ideas and engage with the Microsoft Foundry community
  • Pull Requests: Contribute direct improvements to content, especially AI templates and guides
  • Microsoft Foundry Discord: Participate in #Azure channel for AZD + AI discussions
  • Community Forums: Participate in broader Azure developer discussions

Feedback Categories

  • AI Content Accuracy: Corrections to AI service integration and deployment information
  • Learning Experience: Suggestions for improved AI developer learning flow
  • Missing AI Content: Requests for additional AI templates, patterns, or examples
  • Accessibility: Improvements for diverse learning needs
  • AI Tool Integration: Suggestions for better AI development workflow integration
  • Production AI Patterns: Enterprise AI deployment pattern requests

Response Commitment

  • Issue Response: Within 48 hours for reported problems
  • Feature Requests: Evaluation within one week
  • Community Contributions: Review within one week
  • Security Issues: Immediate priority with expedited response

Maintenance Schedule

Regular Updates

  • Monthly Reviews: Content accuracy and link validation
  • Quarterly Updates: Major content additions and improvements
  • Semi-Annual Reviews: Comprehensive restructuring and enhancement
  • Annual Releases: Major version updates with significant improvements

Monitoring and Quality Assurance

  • Automated Testing: Regular validation of code examples and links
  • Community Feedback Integration: Regular incorporation of user suggestions
  • Technology Updates: Alignment with latest Azure services and azd releases
  • Accessibility Audits: Regular review for inclusive design principles

Version Support Policy

Current Version Support

  • Latest Major Version: Full support with regular updates
  • Previous Major Version: Security updates and critical fixes for 12 months
  • Legacy Versions: Community support only, no official updates

Migration Guidance

When major versions are released, we provide:

  • Migration Guides: Step-by-step transition instructions
  • Compatibility Notes: Details about breaking changes
  • Tool Support: Scripts or utilities to assist with migration
  • Community Support: Dedicated forums for migration questions

Navigation

Stay Updated: Watch this repository for notifications about new releases and important updates to the learning materials.