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 Go API&SDK documentation to new structure #5689

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

[Meta] Migrate Go API&SDK documentation to new structure #5689

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

Comments

@svrnm
Copy link
Member

svrnm commented Nov 26, 2024

Tasks

  • Rename "Getting Started" to "Getting Started by Example"
  • Replace Instrumentation, Libraries, Exporters, Resources, Sampling 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 Go" page
  • Add any additional pages and resources that the Go 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 Go

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

@vitorvasc
Copy link
Contributor

Not a go mantainer, but I can help with this one. Let me know if I have the green light for it!

@svrnm

@svrnm
Copy link
Member Author

svrnm commented Dec 12, 2024

@vitorvasc you don't have to be a go maintainer, but the @open-telemetry/go-maintainers and @open-telemetry/go-approvers will be the ones that need to approve any updates. I suggest that you start with some smaller changes and then work towards the bigger ones. Let me know if you need any assistance

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:go
Projects
Status: No status
Development

No branches or pull requests

2 participants