MicrosoftDocs / azure-docs-sdk-python

Azure Python SDK documentation, hosted on docs.microsoft.com.
https://docs.microsoft.com/python/api
Creative Commons Attribution 4.0 International
124 stars 235 forks source link

Update monitor-opentelemetry-exporter-readme.md #1867

Closed lzchen closed 5 months ago

lzchen commented 5 months ago

Add excerpt to help users decide on whether to use the distro or exporter. Also added data collection basics as a prerequisite read.

learn-build-service-prod[bot] commented 5 months ago

Learn Build status updates of commit c9790c4:

:warning: Validation status: warnings

File Status Preview URL Details
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md :warning:Warning View (azure-python-preview) Details

docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

learn-build-service-prod[bot] commented 5 months ago

Learn Build status updates of commit 95b1e05:

:warning: Validation status: warnings

File Status Preview URL Details
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md :warning:Warning View (azure-python-preview) Details

docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

lzchen commented 5 months ago

sign-off

lzchen commented 5 months ago

@scbedd can this be reviewed?

scbedd commented 5 months ago

Hey @lzchen these changes look good, but unfortunately what will happen is on the very next release, your changes will be wiped out!

The readme file you changed in this repo is auto-populated from this readme file when we release a new version of the azure-monitor-opentelemetry-exporter package.

I will gladly sign off this review after you merge a PR to the repo w/ these same changes.

CC @danieljurek @JimSuplizio

lzchen commented 5 months ago

@scbedd

Thanks for the headsup. I am already making the same changes in that README file in this [pr](https://github.com/Azure/azure-sdk-for-python/pull/34462. If this doc is indeed populated from that README file then I can close this PR.