opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

[Meta] Standardize exporters docs

Open svrnm opened this issue 2 years ago • 6 comments

Description

Based on #3355 all exporter pages should follow a similar structure (where applicable). In a second step we can extract common text blocks into snippets managed at one place.

  • [x] C++ (#3998)
  • [x] .NET
  • [ ] Erlang/Elixir
  • [ ] Go
  • [x] Java (#3558)
  • [x] JavaScript (#3355)
  • [ ] PHP
  • [x] Python (#3515)
  • [ ] Ruby
  • [ ] Rust
  • [ ] Swift

How you can help

Take a language of your choice and use the structure of the JavaScript Exporters page as template (the "browser" part is not applicable for other languages and can be skipped)

svrnm avatar Nov 17 '23 11:11 svrnm

I would also love to add value on this issue!

justankiit avatar Nov 18 '23 07:11 justankiit

I would also love to add value on this issue!

Thanks @kumarankit999, what's a language you feel comfortable with tackling?

svrnm avatar Nov 20 '23 10:11 svrnm

if this issue is still active, please assign this issue to me, thanks

kennykguo avatar Feb 19 '24 01:02 kennykguo

@kennykguo this is a meta issue, which will not be assigned. You can take a look at an individual language and see if you can help with that.

svrnm avatar Feb 20 '24 08:02 svrnm

I would like to work in GO!

justankiit avatar Feb 22 '24 05:02 justankiit

@kumarankit999 that's great to hear! Please take a look at some of the docs that are completed already (Python, C++, JS. Pick one as your starting point, pick the underlying markdown file and build the updated version from there.

You can also take a look at this ongoing PR for .NET to see how you can tackle this:

https://github.com/open-telemetry/opentelemetry.io/pull/4016

Thank you

svrnm avatar Feb 22 '24 09:02 svrnm