docs: Readme updates26367 #626
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request updates the
docs/DeploymentGuide.mdfile to improve clarity and completeness of deployment instructions, particularly around environment selection, security practices, and post-deployment workflows. The documentation now better distinguishes between sandbox and Well-Architected Framework (WAF)-aligned deployments, adds detailed security guidance for Cosmos DB, and introduces safer redeployment steps.Deployment environment selection and security:
Added a dedicated section explaining the difference between sandbox and WAF-aligned deployment options, including step-by-step instructions for enabling required Azure features for production deployments.
Introduced a comprehensive security considerations section for Cosmos DB, detailing access controls, network restrictions, and RBAC practices for both sandbox and production environments.
Post-deployment workflow improvements:
azd initafter initial setup to prevent configuration loss.Does this introduce a breaking change?
How to Test
check the changes in dev-v3
What to Check
Verify that the readme is up to date