Skip to content

Conversation

@lzchen
Copy link
Contributor

@lzchen lzchen commented Feb 26, 2024

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

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
Copy link
Contributor

Learn Build status updates of commit c9790c4:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md ⚠️Warning 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 95b1e05:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md ⚠️Warning 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:

@lzchen
Copy link
Contributor Author

lzchen commented Feb 26, 2024

#sign-off

@lzchen
Copy link
Contributor Author

lzchen commented Feb 27, 2024

@scbedd can this be reviewed?

@scbedd
Copy link
Collaborator

scbedd commented Feb 27, 2024

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
Copy link
Contributor Author

lzchen commented Feb 27, 2024

@scbedd

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.

@lzchen lzchen closed this Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants