docs: improve alternative backend and client discoverability#1985
Open
axelray-dev wants to merge 2 commits into
Open
docs: improve alternative backend and client discoverability#1985axelray-dev wants to merge 2 commits into
axelray-dev wants to merge 2 commits into
Conversation
Fixes pydantic#484 - alternative-backends.md: add keywords for search indexing (self-hosted backend, collector, Jaeger, Grafana Tempo, OTLP-compatible server) - alternative-clients.md: add language examples for search indexing (Node.js, Rust, Go, Ruby, OpenTelemetry SDK) - why.md: replace vague 'cross-language data integration' with explicit links to Alternative Clients and Alternative Backends pages
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
1 issue found across 3 files
Confidence score: 4/5
- This PR is likely safe to merge with minimal risk because the reported issue is documentation-only and does not indicate runtime or functional regression.
- The main concern is a user-facing docs inconsistency:
docs/how-to-guides/alternative-clients.mdsays Node.js and Rust are outside first-class support, which conflicts withdocs/languages.mdand the page’s own SDK references. - Given the moderate severity (5/10) but high confidence (9/10), this is worth correcting soon to avoid reader confusion about supported languages.
- Pay close attention to
docs/how-to-guides/alternative-clients.mdanddocs/languages.md- ensure language support statements are consistent across docs.
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
These languages have custom first-class SDKs per docs/languages.md. Keep only Go, Ruby, and generic OpenTelemetry SDK languages as examples of languages outside first-class support.
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
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.
Fixes #484
What changed
Three minimal docs-only edits to improve search discoverability for alternative backends and alternative clients:
docs/how-to-guides/alternative-backends.md: Added a sentence after the intro paragraph mentioning searchable keywords ("self-hosted backend", "collector", "Jaeger", "Grafana Tempo", "OTLP-compatible server").docs/how-to-guides/alternative-clients.md: Added language examples after "first-class supported languages": Go, Ruby, OpenTelemetry SDK. (Node.js and Rust removed from examples since they have first-class SDKs per docs/languages.md.)docs/why.md: Replaced the vague "cross-language data integration and data export to any OpenTelemetry-compatible backend or proxy" with explicit links to the Alternative Clients and Alternative Backends pages, mentioning Node.js, Rust, Go, Jaeger, and Grafana Tempo.Why this helps search/discoverability
The docs site uses Algolia search (
alt-logfire-docsindex). Users searching for "opentelemetry server", "self-hosted backend", "OTLP", "Jaeger", "collector", "Go", "Ruby", or "alternative clients" will now find these pages more easily because:why.mdnow links directly to both pages, creating discoverable cross-referencesalternative-clients.mdmatch common search queriesChecks run
Skipped checks
pydantic/unified-docspipeline, not locally).