Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Meta] Migrate C++ API&SDK documentation to new structure #5686

Open
5 tasks
svrnm opened this issue Nov 26, 2024 · 3 comments
Open
5 tasks

[Meta] Migrate C++ API&SDK documentation to new structure #5686

svrnm opened this issue Nov 26, 2024 · 3 comments
Labels
0-meta help wanted Extra attention is needed sig:cpp

Comments

@svrnm
Copy link
Member

svrnm commented Nov 26, 2024

Tasks

  • Rename "Getting Started" to "Getting Started by Example"
  • Replace Instrumentation, Libraries, Exporters pages with "Record Telemetry with the API", "Manage Telemetry with the SDK", "Configure the SDK" and "Configure the SDK" pages
  • Add "Instrumentation ecosystem" page
  • Add "Intro to OpenTelemetry C++" page
  • Add any additional pages and resources that the C++ SIG likes to add within their space

Background

Based on Restructure Language SDK & API documentation information architecture - #4853 we rolled out an updated information architecture for the language API & SDK documentations for Java via #4966 and other PRs: https://opentelemetry.io/docs/languages/java/api/

As announced on the discussion and during a maintainer's call we want to roll out the same changes across all other languages. This is the meta issue for C++

cc @open-telemetry/cpp-approvers @open-telemetry/cpp-maintainers

@devatbosch
Copy link

Hi @svrnm ,

Wanted to know is this issue still valid and open if so I would like to take it up. Also, apart from the requirements listed in Tasks & Background section, is there anything else I need to take care of...

Please do let me know...

Thank You!

@svrnm
Copy link
Member Author

svrnm commented Feb 6, 2025

@devatbosch this issue is still open, to address it, you would need to review the Java docs first and see how they can be translated to C++. This can be a step-by-step process

@devatbosch
Copy link

@svrnm , got it. Sure, am checking on it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-meta help wanted Extra attention is needed sig:cpp
Projects
Status: No status
Development

No branches or pull requests

2 participants