open-telemetry / open-telemetry/opentelemetry-cpp
[Docs] - Add Getting Started docs, and Reference API document
Open
Nobody has claimed this yet.
do-not-stale
documentation
logs
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 632
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 75
Description
- Getting started docs can be added here - https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/instrumentation/cpp
- Reference API for
traceandmetricsis here - https://labhas-opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/otel_docs.html. We can add for logs too. Refer this PR on how the metrics was integrated - https://github.com/open-telemetry/opentelemetry-cpp/pull/1678
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the C++ instrumentation content directory in opentelemetry.io and the existing Reference API documentation at the linked ReadTheDocs page. Use PR 1678 as the example for integrating metrics documentation. Done means adding Getting Started documentation and Reference API coverage for trace, metrics, and logs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100