open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
497 stars 1.03k forks source link

[Meta] Standardize instrumentation docs with sample app #3229

Open svrnm opened 10 months ago

svrnm commented 10 months ago

Since we are very close to have standardized the "Getting Started" docs for all languages (see https://github.com/open-telemetry/opentelemetry.io/issues/2623), we can do the same now for other pages as well. Code-based Instrumentation is the next important one, so I create a ticket similar to #2623.

Each page should have a structure like the following:

Note

To implement this for a new language, please take a documentation from an existing language (https://opentelemetry.io/docs/instrumentation/js/manual/, https://opentelemetry.io/docs/instrumentation/java/manual/) and adjust it for the language you picked

Also, it is not necessary do solve all points in one PR, doing Example App + Setup + Traces first is a good point to get started.

Tracking:

theletterf commented 9 months ago

I'd like to help with this.

cartermp commented 9 months ago

great! Feel free to just pick one and send a PR; I don't think we have any preferred ordering 🙂

IAMebonyhope commented 6 months ago

I'll love to work on the .NET part

svrnm commented 6 months ago

@IAMebonyhope that's great to hear! To get started I recommend that you take one of the existing docs (java, JavaScript) and use them as a blueprint to create the same part for .NET (example app, setup, traces). Our goal is to provide a consistent and standardized documentation, so you can copy the outline and the words and fill in the .NET code and fix the wording where necessary. Don't hesitate to provide a draft PR early to get our feedback! Thank you!

IAMebonyhope commented 6 months ago

@svrnm here is a draft PR #3834 The example app and manual instrumentation setup sections are ready for review. I am still working on the traces section.