-
Notifications
You must be signed in to change notification settings - Fork 258
Update monitor-opentelemetry-exporter-readme.md #1867
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
Conversation
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 status updates of commit c9790c4:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md | View (azure-python-preview) | Details |
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md
- Line 2, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 7, Column 13: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.service': 'monitor'. - Line 13, Column 53: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 13, Column 199: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 2, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 11, Column 428: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python' will be broken in isolated environments. Replace with a relative link. - Line 13, Column 53: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python' will be broken in isolated environments. Replace with a relative link. - Line 13, Column 199: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types' will be broken in isolated environments. Replace with a relative link. - Line 148, Column 105: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/azure/azure-monitor/app/azure-ad-authentication?tabs=python' will be broken in isolated environments. Replace with a relative link.
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:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 95b1e05:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md | View (azure-python-preview) | Details |
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md
- Line 2, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 7, Column 13: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.service': 'monitor'. - Line 13, Column 53: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 13, Column 199: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 2, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 11, Column 428: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python' will be broken in isolated environments. Replace with a relative link. - Line 13, Column 53: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python' will be broken in isolated environments. Replace with a relative link. - Line 13, Column 199: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types' will be broken in isolated environments. Replace with a relative link. - Line 148, Column 105: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/azure/azure-monitor/app/azure-ad-authentication?tabs=python' will be broken in isolated environments. Replace with a relative link.
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:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
#sign-off |
|
@scbedd can this be reviewed? |
|
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 I will gladly sign off this review after you merge a PR to the repo w/ these same changes. |
|
Thanks for the headsup. I am already making the same changes in that README file in this [pr](Azure/azure-sdk-for-python#34462. If this doc is indeed populated from that README file then I can close this PR. |
Add excerpt to help users decide on whether to use the distro or exporter. Also added data collection basics as a prerequisite read.