Skip to content

Conversation

@Roopan-Microsoft
Copy link
Collaborator

Purpose

  • This pull request updates the README.md and 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:

  • README.md: Added detailed deployment options, including GitHub Codespaces, VS Code Dev Containers, and local environments. Introduced a table for configurable deployment settings with default values. Added instructions for quota recommendations and resource cleanup after failed deployments. [1] [2]
  • CustomizingAzdParameters.md: Provided commands to customize Azure deployment parameters, such as model type, capacity, and embedding model settings.

Responsible AI and Cost Transparency:

  • README.md: Added a section for responsible AI transparency with a link to the 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?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft changed the title docs: Updates the README.md and supporting documentation to improve deployment instructions docs: updates the README.md and supporting documentation to improve deployment instructions Apr 22, 2025
@Roopan-Microsoft Roopan-Microsoft changed the title docs: updates the README.md and supporting documentation to improve deployment instructions docs: updates the README.md and supporting documentation to improve deployment instructions Apr 22, 2025
Copy link
Contributor

@marktayl1 marktayl1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

@marktayl1 marktayl1 merged commit bf79fbb into feature/azd-semantickernel Apr 22, 2025
3 of 5 checks passed
@github-actions
Copy link

github-actions bot commented May 2, 2025

🎉 This PR is included in version 1.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Roopan-Microsoft Roopan-Microsoft deleted the psl-readme-update branch July 17, 2025 12:07
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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants