docs(deploy): add deployment strategy decision guide #1061
+851
−0
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
Add comprehensive best practices guide covering: - File upload handling patterns (both uploaded files and file paths) - Type annotation requirements - Tool naming conventions - Docstring standards - Error handling patterns - Structured return values Addresses common pitfalls and provides examples for building robust function tools in ADK. Relocates content from google/adk-python#3193 as requested by @boyangsvl.
Add new best practices guide to mkdocs.yml navigation under 'Custom Tools > Function tools' section. Fixes mkdocs build warning about page not in nav configuration.
- Move from tools/ to tools-custom/ to match existing Custom Tools organization - Update navigation path in mkdocs.yml to maintain structural consistency - Addresses path inconsistency while preserving approved content
jpantsjoha
force-pushed
the
docs/deployment-decision-guide
branch
from
065050c to
108420a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a Deployment Strategy Guide (Decision Matrix) to address confusion between Agent Engine and Cloud Run deployment options.
References Issue #3500 in adk-python (cross-repo documentation issue).
Changes
docs/deploy/decision-guide.md: A comprehensive decision matrix and guide.mkdocs.yml: Added the new guide to the Deployment navigation section.Why
As noted in community feedback, developers struggle to choose between the 'Accelerated' (Agent Engine) and 'Standard' (Cloud Run) paths. This guide clarifies the trade-offs (Managed vs Control) upfront.