pydantic/logfire

Improve search for alternative backends/clients

Open

#484 opened on Oct 9, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (244 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (4,282 stars)
PR merge metrics
 (Avg merge 7d 8h) (35 merged PRs in 30d)

Description

Ideas based on https://pydanticlogfire.slack.com/archives/C06EDRBSAH3/p1728466950149999:

  1. Searching for "opentelemetry" should return https://logfire.pydantic.dev/docs/guides/advanced/alternative-clients/ and https://logfire.pydantic.dev/docs/guides/advanced/alternative-backends/ as the first results
  2. https://logfire.pydantic.dev/docs/guides/advanced/alternative-backends/ should mention the word 'server' and any other keywords likely to be searched
  3. https://logfire.pydantic.dev/docs/why-logfire/opentelemetry/ should link to both those pages.
  4. https://logfire.pydantic.dev/docs/why-logfire/opentelemetry/ should make the alternative clients point clearer - I think that's what "supports cross-language data integration" is trying to say but I'm not sure.

Contributor guide

Research direction
Implement the four suggestions: 1) Update search configuration to prioritize alternative clients and alternative backends for 'opentelemetry' query; 2) Add keyword 'server' to alternative backends page; 3) Add links from opentelemetry page to both pages; 4) Clarify the alternative clients point on opentelemetry page.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic understanding of documentation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80