-
Notifications
You must be signed in to change notification settings - Fork 416
docs: updates the README.md and supporting documentation to improve deployment instructions
#100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
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
README.md and supporting documentation to improve deployment instructionsREADME.md and supporting documentation to improve deployment instructions
README.md and supporting documentation to improve deployment instructionsREADME.md and supporting documentation to improve deployment instructions
marktayl1
approved these changes
Apr 22, 2025
Contributor
marktayl1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
|
🎉 This PR is included in version 1.3.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
blessing-msft
pushed a commit
that referenced
this pull request
Aug 1, 2025
docs: updates the `README.md` and supporting documentation to improve deployment instructions
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
README.mdand supporting documentation to improve deployment instructions, add configuration options, and enhance resource management guidance. It also introduces new sections for responsible AI practices, cost considerations, and security guidelines.Deployment and Configuration Enhancements:
CustomizingAzdParameters.md: Provided commands to customize Azure deployment parameters, such as model type, capacity, and embedding model settings.Responsible AI and Cost Transparency:
TRANSPARENCY_FAQ.md. Included a breakdown of potential costs for Azure services and a reminder to delete unused resources to avoid unnecessary charges.Resource Management:
DeleteResourceGroup.md: Added a new guide for manually deleting Azure resources after a failed deployment, with step-by-step instructions and visuals.Quota Management:
AzureGPTQuotaSettings.md: Added instructions for checking and updating Azure AI quotas, including selecting regions and managing deployed models.These changes aim to streamline the deployment process, provide clarity on resource usage, and align with best practices for responsible AI and security.
Does this introduce a breaking change?
How to Test
What to Check
Verify that the following are valid
Other Information