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): introduce observing ai workflows documentation #1908

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

MichaelDoyle
Copy link
Member

@MichaelDoyle MichaelDoyle commented Feb 10, 2025

This PR is the first in a series, attempting to alleviate a fairly broad set of current pain points with the telemetry docs. Here are a few of those:

  • Streamline set-up of Firebase Genkit Monitoring by giving it a dedicated section in the docs
  • Disambiguate Firebase Genkit (production) Monitoring from general observability features of the framework
  • Prioritize firebase plugin over google-cloud plugin and generally alleviate confusion between the two
  • Set up firebase plugin docs to "stand alone" i.e. do not delegate out to cloud plugin docs
  • Refer to API docs as the source of truth for plugin configuration, instead focussing on use-cases
  • Remove confusing and/or erroneous authentication documentation and assumptions
  • Enable troubleshooting

Checklist (if applicable):

@github-actions github-actions bot added docs Improvements or additions to documentation js config labels Feb 10, 2025
Copy link
Contributor

@schnecle schnecle left a comment

Choose a reason for hiding this comment

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

This is looking awesome!

docs/_guides.yaml Outdated Show resolved Hide resolved
docs/observability/getting-started.md Show resolved Hide resolved
docs/observability/getting-started.md Outdated Show resolved Hide resolved
docs/observability/getting-started.md Show resolved Hide resolved
@MichaelDoyle MichaelDoyle force-pushed the telemetry-firebase-docs branch 2 times, most recently from aedb410 to 1702294 Compare February 11, 2025 02:36
@MichaelDoyle MichaelDoyle force-pushed the telemetry-firebase-docs branch from 1702294 to 00ddb82 Compare February 12, 2025 02:14
@MichaelDoyle MichaelDoyle force-pushed the telemetry-firebase-docs branch from 00ddb82 to 916f49e Compare February 12, 2025 02:30
Copy link
Contributor

@thedmail thedmail left a comment

Choose a reason for hiding this comment

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

approved. editorial pass to follow.

@thedmail thedmail merged commit ce45aca into main Feb 12, 2025
7 checks passed
@thedmail thedmail deleted the telemetry-firebase-docs branch February 12, 2025 02:40
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.

4 participants