-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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] Standardize instrumentation docs with sample app #3229
Comments
I'd like to help with this. |
great! Feel free to just pick one and send a PR; I don't think we have any preferred ordering 🙂 |
I'll love to work on the .NET part |
@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! |
Hi @svrnm i'm a contributor from outreachy and will like to help with this |
@Victorsesan for the outreachy project, please take a look here: #5290 |
Since we are very close to have standardized the "Getting Started" docs for all languages (see #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:
The text was updated successfully, but these errors were encountered: