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

docs(observability): Add advanced configuration, authentication, and telemetry collection docs #1969

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

schnecle
Copy link
Contributor

@schnecle schnecle commented Feb 13, 2025

  • Pull advanced configuration options into a use case based general page
  • Pull common authentication steps into a general page
  • Pull descriptions of collected metrics into a common observability page and add in sections for traces and logs
  • Remove duplicated sections from Google Cloud and Firebase plugins and reference the general observability docs

Checklist (if applicable):

@github-actions github-actions bot added docs Improvements or additions to documentation config labels Feb 13, 2025
Copy link
Member

@MichaelDoyle MichaelDoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I made a bunch of nit picky grammatical tweaks you can take or leave.

A few broad callouts I want to make, though:

  1. I think we need to decide when and where we refer to "telemetry plugin" and when we refer to "genkit monitoring". Especially since we are doing double-duty with the plugin, wrt "firebase" and "google cloud".

  2. In some ways, we are doing a bit of a round-a-bout by pointing the Google Cloud docs to the Firebase instructions (whereas before it was the opposite). It's much improved, no doubt.

    • One thing we talked about that could potentially help is making "includeable" snippets that can go into all 3 docs ("Observing AI workflows, Firebase Plugin, Cloud Plugin).

@schnecle schnecle force-pushed the schnecle/observability-docs branch 2 times, most recently from b3d3eb8 to eee4365 Compare February 18, 2025 22:21
@schnecle schnecle force-pushed the schnecle/observability-docs branch from eee4365 to b714155 Compare February 19, 2025 16:44
@github-actions github-actions bot added the js label Feb 19, 2025
@schnecle schnecle force-pushed the schnecle/observability-docs branch from b714155 to b091bff Compare February 19, 2025 16:53
@schnecle schnecle merged commit 0a4d45b into main Feb 19, 2025
7 checks passed
@schnecle schnecle deleted the schnecle/observability-docs branch February 19, 2025 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config docs Improvements or additions to documentation js
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants