Simplify OpenTelemetry APM getting started documentation #17372
Conversation
|
Hi @alanwest 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
...-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-intro.mdx
Outdated
Show resolved
Hide resolved
...-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-intro.mdx
Outdated
Show resolved
Hide resolved
ally-sassman
added
content
There was a problem hiding this comment.
Looks good!
One thing worse discussing: We've removed any sort of general setup instructions, instead redirecting folks to language specific setup which are all are telling readers the same set of things. We have 6 sets of language specific examples while there are 11 otel language APIs / SDKs in some stage of development. If a user asks how to setup in a language we haven't provided an example for yet (seems inevitable) do you think we should just add a new example for that language rather than provide some generic set of instructions?
There was a problem hiding this comment.
@jack-berg I think we could add a line saying, "If you're looking for more language-specific examples, submit a request (add link to do this, such as submitting a GitHub issue)"
cc @alanwest thoughts?
There was a problem hiding this comment.
That's a good idea @ally-sassman. Gives the user a concrete call to action, and provides us with a signal that someone is actively interested in an additional example.
There was a problem hiding this comment.
@jack-berg Would either of you be notified if they submitted an issue here: https://github.com/newrelic/newrelic-opentelemetry-examples/issues/new?assignees=&labels=enhancement%2C+needs-triage&projects=&template=enhancement.md&title= ?
| <TechTile | ||
| name="Python" | ||
| icon="logo-python" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/python" |
There was a problem hiding this comment.
Reminder to merge newrelic/newrelic-opentelemetry-examples#598
...-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-intro.mdx
Outdated
Show resolved
Hide resolved
…rations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-intro.mdx Co-authored-by: ally sassman <[email protected]>
No description provided.