Update the docs and dev container based off recent feedback #2224
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
Fixes #2220, Fixes #2109
This pull request includes various updates to documentation, dependency management, and configuration files. The changes aim to improve deployment options, update dependencies, and enhance the documentation for better clarity and usability. Below are the most important changes:
Dependency Updates:
docker-in-docker
feature in.devcontainer/devcontainer.json
. This is required for folks who are deploying to free trial accounts, as they can't use the remoteBuild feature. I'll check that the Codespace still loads up fine.opentelemetry-instrumentation-requests
fromapp/backend/requirements.in
. As I was documenting opentelemetry packages, I realized that's a dead import - no longer used anywhere. We moved from requests to aiohttp entirely at some point.Documentation Enhancements:
docs/deploy_freetrial.md
.docs/deploy_lowcost.md
to provide clearer instructions for switching to the free tier of Azure App Service and using OpenAI.com. [1] [2]docs/gpt4v.md
to provide a clearer explanation of the GPT vision model feature and its deployment steps. [1] [2]docs/monitoring.md
.docs/login_and_acl.md
to support additional endpoints and permissions. [1] [2]Does this introduce a breaking change?
When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
If you're not sure, try it out on an old environment.
Does this require changes to learn.microsoft.com docs?
This repository is referenced by this tutorial
which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.
Type of change
Code quality checklist
See CONTRIBUTING.md for more details.
python -m pytest
).python -m pytest --cov
to verify 100% coverage of added linespython -m mypy
to check for type errorsruff
andblack
manually on my code.