docs: Added content in Readme and deploymentguide for SFI issue #402
Merged
Roopan-Microsoft merged 4 commits intodevfrom Apr 10, 2026
Merged
docs: Added content in Readme and deploymentguide for SFI issue #402Roopan-Microsoft merged 4 commits intodevfrom
Roopan-Microsoft merged 4 commits intodevfrom
Conversation
fix: merging dev to main
fix: Enhance CosmosDBClient and DatabaseFactory for error handling and concurrency
Added important notes regarding security restrictions and Azure OpenAI quota availability.
Added note about security restrictions impacting deployment.
Thanusree-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
dgp10801,
marktayl1,
nchandhi and
toherman-msft
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation notes warning that some tenants may enforce periodic security restrictions that can disrupt the deployed application, and points readers to the deployment-type guidance (including the WAF-aligned/production option).
Changes:
- Added a tenant-restrictions note to the main README quick-deploy section.
- Added the same note to the Deployment Guide overview with an anchor link to section 3.1.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a note about tenant security restrictions and links to deployment-type configuration guidance. |
| docs/DeploymentGuide.md | Adds the same note near the top of the deployment guide and links to section 3.1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| <br/> | ||
|
|
||
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-supported version to ensure compliance. To configure, [Click here](./docs/DeploymentGuide.md#31-choose-deployment-type-optional). |
There was a problem hiding this comment.
The note refers to a "WAF-supported version", but elsewhere in the docs (and earlier in this README) the terminology is "WAF-aligned" / "WAF-Aligned deployment option". Consider aligning the wording here to the established term to avoid confusion about which deployment path to choose.
Suggested change
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-supported version to ensure compliance. To configure, [Click here](./docs/DeploymentGuide.md#31-choose-deployment-type-optional). | |
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-aligned version to ensure compliance. To configure, [Click here](./docs/DeploymentGuide.md#31-choose-deployment-type-optional). |
|
|
||
| 🆘 **Need Help?** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems. | ||
|
|
||
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-supported version to ensure compliance. To configure, [Click here](#31-choose-deployment-type-optional). |
There was a problem hiding this comment.
This note mentions deploying the "WAF-supported version", but the rest of the documentation describes this as the "Production" / "WAF-aligned" deployment option. Please use the same term here (and/or explicitly reference "Production" in section 3.1) to avoid ambiguity.
Suggested change
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-supported version to ensure compliance. To configure, [Click here](#31-choose-deployment-type-optional). | |
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the Production (WAF-aligned) deployment option to ensure compliance. To configure, [Click here](#31-choose-deployment-type-optional). |
Roopan-Microsoft
approved these changes
Apr 10, 2026
|
🎉 This PR is included in version 1.8.0 🎉 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
Does this introduce a breaking change?
Yes
No
Other Information
Added content in Readme for SFI issue