open-telemetry / open-telemetry/opentelemetry-python

Add common pitfalls/FAQ to documentation

Open
#1,875 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc help wanted triaged
Dominant language
Python
Stars
2.6k
Forks
1k
Avg merge
4d 15h
Merged PRs (30d)
19

Description

It would be nice to have a page where common issues and questions that users have can be covered.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a documentation file, test, or entry point. Start by locating the existing documentation structure and reviewing recurring user questions and issues; done means a clearly organized page covering agreed common pitfalls and FAQs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.