open-telemetry/opentelemetry-php

Troubleshooting Guide / FAQ

Open

#1,321 opened on Jun 5, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)PHP (224 forks)auto 404
bite sizeddocumentationhelp wanted

Repository metrics

Stars
 (894 stars)
PR merge metrics
 (Avg merge 5d 5h) (5 merged PRs in 30d)

Description

Is your feature request related to a problem?

@agoallikmaa mentioned that he has helped people set up the opentelemetry-php package in their specific environments. When doing so, the consumers of the library have run into some similar pitfalls.

Describe the solution you'd like We'd like to create a FAQ / Troubleshooting document. This may have some crossover with the library documentation, but it might be helpful for new contributors to ensure that they are performing all of the things they need to do to get the library working.

Contributor guide

Research direction
Gather common pitfalls and setup issues from discussions and existing issues, then compile a FAQ document.
Tech stack
php
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90