Skip to content
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

Update the docs and dev container based off recent feedback #2224

Merged
merged 4 commits into from
Dec 12, 2024

Conversation

pamelafox
Copy link
Collaborator

@pamelafox pamelafox commented Dec 11, 2024

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:

  • Added 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.
  • Removed opentelemetry-instrumentation-requests from app/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:

  • Added detailed instructions for deploying with a free trial account in docs/deploy_freetrial.md.
  • Updated docs/deploy_lowcost.md to provide clearer instructions for switching to the free tier of Azure App Service and using OpenAI.com. [1] [2]
  • Enhanced docs/gpt4v.md to provide a clearer explanation of the GPT vision model feature and its deployment steps. [1] [2]
  • Added sections on performance, failures, dashboard, and customizing traces in docs/monitoring.md.
  • Updated redirect URIs and added Microsoft Graph API permissions in 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.

[ ] Yes
[X] No

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.

[X] Yes - I'm speaking with John Alexander about the free trial wording there.
[ ] No

Type of change

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

Code quality checklist

See CONTRIBUTING.md for more details.

  • The current tests all pass (python -m pytest).
  • I added tests that prove my fix is effective or that my feature works
  • I ran python -m pytest --cov to verify 100% coverage of added lines
  • I ran python -m mypy to check for type errors
  • I either used the pre-commit hooks or ran ruff and black manually on my code.

@pamelafox
Copy link
Collaborator Author

Update from manual testing: Codespace opened fine, a deploy with these changes is working fine.

@pamelafox
Copy link
Collaborator Author

I'm merging this, but feel free to send post-merge feedback.

@pamelafox pamelafox merged commit 431bbe6 into Azure-Samples:main Dec 12, 2024
13 checks passed
@pamelafox pamelafox deleted the docs-refresh branch December 12, 2024 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TasksOperationsNotAllowed unable to do local debugging for ALC related features because login does not work
1 participant