Restructure BigQuery Agent Analytics doc for scannability#1726
Merged
Conversation
## Summary Full restructure of the BigQuery Agent Analytics plugin doc, addressing google#1710. Two phases in one PR: ### Phase 1 — Additive tables (no section moves) - **Captured-events summary table**: 19-row table near the top listing all event types, when they fire, key fields, and corresponding view - **Configuration reference tables**: Converted bullet list to two 4-column tables (constructor params + BigQueryLoggerConfig) - **Collapsible DDL**: Production DDL wrapped in `??? example` admonition - **Conversational Analytics**: Demoted from standalone `##` to `###` under query section ### Phase 2 — Structural reorder - **Shortened quickstart**: Minimal 3-import example; full example with GCS/OTel/BigQuery tools moved to collapsible block - **Agent Runtime moved later**: From position 4 (interrupting core narrative) to position 9 (after query recipes) - **GCS offloading extracted**: From nested `####` under "Event types" to its own `## Storage behavior: GCS offloading` - **Query recipes regrouped by task**: Debug a run, Monitor cost/performance, Inspect tools/interactions, Analyze multimodal, AI root cause, Conversational Analytics - **Operations consolidated**: Tracing, Public methods, and Multiprocessing grouped under one `## Operations` section - **New anchors**: `{#prerequisites}`, `{#configuration-options}` ### New section order 1. Overview + Use cases + Captured events 2. Quickstart (shortened) 3. Prerequisites + IAM 4. Configuration (tables) 5. Schema + Views 6. Event types + payloads 7. Storage behavior: GCS offloading 8. Query recipes (task-grouped) 9. Deploy to Agent Runtime 10. Security + redaction 11. Operations (tracing, methods, multiprocessing) 12. SDK / dashboards 13. Feedback + resources ### Anchors All 5 existing anchors preserved: `#deploy-agent-runtime`, `#event-types`, `#hitl-events`, `#security-credentials`, `#built-in-redaction`. Added: `#prerequisites`, `#configuration-options`. ## Test plan - [ ] Quickstart renders with minimal example + collapsible full example - [ ] Captured-events table renders all 19 rows - [ ] Config tables render correctly (constructor + BigQueryLoggerConfig) - [ ] DDL is collapsible - [ ] GCS offloading section renders correctly as standalone `##` - [ ] Query recipes show task-based `###` grouping with `####` subsections - [ ] Agent Runtime section appears after query recipes - [ ] Operations section groups tracing + public methods + multiprocessing - [ ] All 7 anchors resolve correctly - [ ] No broken internal cross-references
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
koverholt
approved these changes
May 6, 2026
koverholt
left a comment
koverholt
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for the updates. I performed some cleanup for formatting and style normalization (line wrapping, list markers, whitespace, table separator syntax), markdown convention (converted HTML tables to markdown, replaced a blockquote with a proper admonition), and content correctness (fixed a broken 404 link, corrected the "Colab Data Apps" feature name, fixed an invalid Python example, and updated to use consistent ADK and A2A naming).
joefernandez
pushed a commit
that referenced
this pull request
May 19, 2026
* Restructure BigQuery Agent Analytics doc for scannability ## Summary Full restructure of the BigQuery Agent Analytics plugin doc, addressing #1710. Two phases in one PR: ### Phase 1 — Additive tables (no section moves) - **Captured-events summary table**: 19-row table near the top listing all event types, when they fire, key fields, and corresponding view - **Configuration reference tables**: Converted bullet list to two 4-column tables (constructor params + BigQueryLoggerConfig) - **Collapsible DDL**: Production DDL wrapped in `??? example` admonition - **Conversational Analytics**: Demoted from standalone `##` to `###` under query section ### Phase 2 — Structural reorder - **Shortened quickstart**: Minimal 3-import example; full example with GCS/OTel/BigQuery tools moved to collapsible block - **Agent Runtime moved later**: From position 4 (interrupting core narrative) to position 9 (after query recipes) - **GCS offloading extracted**: From nested `####` under "Event types" to its own `## Storage behavior: GCS offloading` - **Query recipes regrouped by task**: Debug a run, Monitor cost/performance, Inspect tools/interactions, Analyze multimodal, AI root cause, Conversational Analytics - **Operations consolidated**: Tracing, Public methods, and Multiprocessing grouped under one `## Operations` section - **New anchors**: `{#prerequisites}`, `{#configuration-options}` ### New section order 1. Overview + Use cases + Captured events 2. Quickstart (shortened) 3. Prerequisites + IAM 4. Configuration (tables) 5. Schema + Views 6. Event types + payloads 7. Storage behavior: GCS offloading 8. Query recipes (task-grouped) 9. Deploy to Agent Runtime 10. Security + redaction 11. Operations (tracing, methods, multiprocessing) 12. SDK / dashboards 13. Feedback + resources ### Anchors All 5 existing anchors preserved: `#deploy-agent-runtime`, `#event-types`, `#hitl-events`, `#security-credentials`, `#built-in-redaction`. Added: `#prerequisites`, `#configuration-options`. ## Test plan - [ ] Quickstart renders with minimal example + collapsible full example - [ ] Captured-events table renders all 19 rows - [ ] Config tables render correctly (constructor + BigQueryLoggerConfig) - [ ] DDL is collapsible - [ ] GCS offloading section renders correctly as standalone `##` - [ ] Query recipes show task-based `###` grouping with `####` subsections - [ ] Agent Runtime section appears after query recipes - [ ] Operations section groups tracing + public methods + multiprocessing - [ ] All 7 anchors resolve correctly - [ ] No broken internal cross-references * Fix wrapping and formatting * Fix 404 link to data apps * Fix placeholder in code sample * Convert HTML tables to MD tables * Make table formatting consistent w/ docs * Use consistent naming for ADK and A2A * Additional formatting fixes * Remove unused import; convert quote to admonition --------- Co-authored-by: Kristopher Overholt <koverholt@google.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Full restructure of the BigQuery Agent Analytics plugin doc, addressing #1710. Two phases in one PR:
Phase 1 — Additive tables (no section moves)
??? exampleadmonition##to###under query sectionPhase 2 — Structural reorder
####under "Event types" to its own## Storage behavior: GCS offloading## Operationssection{#prerequisites},{#configuration-options}New section order
Anchors
All 5 existing anchors preserved:
#deploy-agent-runtime,#event-types,#hitl-events,#security-credentials,#built-in-redaction. Added:#prerequisites,#configuration-options.Test plan
#####grouping with####subsections