Skip to content

Conversation

@Shreyas-Microsoft
Copy link

Purpose

This pull request significantly improves the deployment documentation by restructuring the README.md and DeploymentGuide.md for better clarity, usability, and troubleshooting. The main enhancements include clearer prerequisites and permissions, a dedicated troubleshooting section, detailed cost estimation, robust environment management guidance, and a comprehensive post-deployment validation checklist. These changes are designed to make the deployment process smoother and help users quickly resolve common issues.

Documentation Restructuring & Usability Improvements:

  • Added a "Quick Start" section and reorganized the DeploymentGuide.md to provide a step-by-step deployment overview, including a clear checklist for prerequisites and deployment validation. [1] [2]
  • Updated the permissions guidance to recommend "Owner" and "User Access Administrator" roles, with a comparison table for least-privilege alternatives and links to detailed setup instructions. [1] [2]

Troubleshooting & Common Issues:

  • Introduced a new troubleshooting section in both the README.md and DeploymentGuide.md, highlighting 25+ common deployment issues and quick solutions, with direct links to a dedicated troubleshooting guide. [1] [2]

Cost Estimation & Regional Guidance:

  • Moved and expanded the cost estimation and regional availability information into a dedicated section in the deployment guide, including a detailed pricing table for all major Azure services used. [1] [2]

Environment Management Enhancements:

  • Added explicit instructions for environment naming, recreation, and cleanup, including PowerShell scripts for generating compliant names and cleaning up old environments to avoid deployment conflicts. [1] [2]

Post-Deployment Validation & Golden Path Workflows:

  • Introduced a comprehensive deployment validation checklist, health check commands, and troubleshooting steps to ensure successful deployment.
  • Added "Golden Path Workflows" and next steps guidance for users to follow best practices and explore advanced solution features.

These improvements should make the deployment process more reliable and user-friendly, helping both new and experienced users avoid common pitfalls and get the most out of the solution.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

Roopan-Microsoft and others added 4 commits November 4, 2025 20:59
ci: update GitHub Action workflow and Deployment documentation
fix: merge from dev to main
@Shreyas-Microsoft Shreyas-Microsoft changed the base branch from main to dev November 14, 2025 09:19
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.

4 participants