Skip to content
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

Update ai-ml-readme.md #1991

Closed
wants to merge 3 commits into from
Closed

Conversation

Blackmist
Copy link

Revisions for SEO. Also to remove text that indicates that this has recently went GA, since it's been GA for over a year now.

Revisions for SEO. Also to remove text that indicates that this has recently went GA, since it's been GA for over a year now.
Copy link
Contributor

Learn Build status updates of commit 8cd8c3d:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/latest/ai-ml-readme.md ⚠️Warning View (azure-python) Details

docs-ref-services/latest/ai-ml-readme.md

  • Line 7, Column 13: [Warning: ms-service-subservice-invalid - See documentation] Invalid value for 'ms.service': 'ml'.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 17, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python' will be broken in isolated environments. Replace with a relative link.
  • Line 17, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python

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:

Copy link
Contributor

Learn Build status updates of commit f452a05:

💡 Validation status: suggestions

File Status Preview URL Details
docs-ref-services/latest/ai-ml-readme.md 💡Suggestion View (azure-python) Details

docs-ref-services/latest/ai-ml-readme.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 17, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python' will be broken in isolated environments. Replace with a relative link.
  • Line 17, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python

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:

Copy link
Contributor

Learn Build status updates of commit c5423df:

💡 Validation status: suggestions

File Status Preview URL Details
docs-ref-services/latest/ai-ml-readme.md 💡Suggestion View (azure-python) Details

docs-ref-services/latest/ai-ml-readme.md

  • Line 18, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python' will be broken in isolated environments. Replace with a relative link.
  • Line 18, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python

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:

@Blackmist
Copy link
Author

#sign-off

@kingernupur
Copy link

@danieljurek @JimSuplizio Please review..

Copy link
Collaborator

@danieljurek danieljurek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is OK but will be overwritten by source documentation on next release... to prevent that make sure that the copy changes also exist in the source documentation by opening a PR.

The description field in the front matter might be overwritten on next release as it's not directly backed by any data fields.

The ms.service value will be overwritten unless the metadata CSV is updated. Set the MSDocService field in this line: https://github.com/Azure/azure-sdk/blob/main/_data/releases/latest/python-packages.csv#L61

More information about metadata is available here: https://eng.ms/docs/products/azure-developer-experience/develop/sdk-docs

@Blackmist
Copy link
Author

Thanks @danialjurek. I'll modify in the source repo instead.

@Blackmist Blackmist closed this Jan 22, 2025
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.

4 participants