-
Notifications
You must be signed in to change notification settings - Fork 703
Move BigQuery Agent Analytics docs to observability directory and update the plugin doc to v2 #1060
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
Move BigQuery Agent Analytics docs to observability directory and update the plugin doc to v2 #1060
Conversation
Updated the documentation for the BigQuery Agent Analytics plugin to clarify event logging configurations and added a code sample for setting up the plugin.
koverholt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR title indicates a move to the plugins dir, but the doc is actually being moved to the observability directory. Do you want to move this to the plugins dir instead?
Also:
- For any moved pages, you'll need to add a redirect to the
plugins.redirectconfig in https://github.com/google/adk-docs/blob/main/mkdocs.yml so that existing external links to the page are not broken - You'll need to update the
navconfig in https://github.com/google/adk-docs/blob/main/mkdocs.yml for where this page should live in the left nav menu
Thanks for the review. @koverholt, actually this PR is aiming to moving the plugin into observability directory. Update the title also update the mkdocs.yml. Please take another look, thanks |
koverholt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fixes. I didn't realize that there was a rewrite of the page since GitHub is not showing the diffs due to the file being moved. So we'll need to do a more thorough review of the content than I initially thought.
The biggest issue that I see is whether we want to include the full documentation on the older deprecated version in the second half of the page. Other than that, there are some rendering issues like the list in the "IAM Permissions" section is not rendering correctly and other consistency issues.
I left comments for these, and will also cc @joefernandez for review as well due to the scope of the changes.
| <br> | ||
| <hr> | ||
|
|
||
| ## Deprecated (v < 1.21.0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we want to include the full content of the old / deprecated version, but I will defer to @joefernandez on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @koverholt , @joefernandez please provide guidance on this, thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@haiyuan-eng-google DO NOT preserve multiple versions of content in a single document; this practice is confusing to you users. Remove the deprecated content from this page. If you want to preserve it, consider adding it as a readme file that's kept with the source code and labeled appropriately, and if you want, link to that deprecated content from here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed the deprecated contents, thanks
Change request resolved: removed deprecated content
No description provided.