docs: Added changes in readme file related to SFI#533
Merged
Roopan-Microsoft merged 3 commits intomainfrom Aug 11, 2025
Merged
Conversation
Atulku-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
malrose07 and
toherman-msft
as code owners
Atulku-Microsoft
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new section to the deployment documentation explaining how to configure environment variables for local development and debugging, specifically focusing on Azure authentication setup.
- Added a new "Environment configuration for local development & debugging" section
- Documented the APP_ENV environment variable configuration for switching between dev and production modes
- Provided step-by-step instructions for setting up the .env file
docs/DeploymentGuide.md
Outdated
| - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources. | ||
|
|
||
| ## Environment configuration for local development & debugging | ||
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**. |
There was a problem hiding this comment.
The phrase 'Use dev to enable to use Azure CLI credential' contains a grammatical error. It should be 'Use dev to enable Azure CLI credential' or 'Use dev to use Azure CLI credential'.
Suggested change
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**. | |
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**. |
docs/DeploymentGuide.md
Outdated
| - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources. | ||
|
|
||
| ## Environment configuration for local development & debugging | ||
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**. |
There was a problem hiding this comment.
The phrase 'when using dev in local' should be 'when using dev locally' for better grammar.
Suggested change
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**. | |
| > Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev locally**. |
Roopan-Microsoft
approved these changes
Aug 11, 2025
Contributor
|
🎉 This PR is included in version 1.6.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Add the content for env changes in DeploymentGuide.md
Does this introduce a breaking change?
Other Information
Added the new section (For local Debugging) in DeploymentGuide.md file