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

[METADATA UPDATE][Merge by 2024-08-21] Global ms.service and ms.subservice metadata update #4531

Merged

Conversation

learn-build-service-prod[bot]
Copy link
Contributor

A Pull Request has been made from the Learn Platform's Metadata Management System. Please review and merge this Pull Request within 5 days. If you have any questions or concerns about the purpose of these metadata updates, please contact [email protected]. If you are not the correct contact for this content and repository, please notify [email protected].

If this Pull Request is not merged within 14 days, it will be automatically merged by our system to ensure the timeliness of the metadata update. This includes bypassing the Repository's Branch Policy, including if Review Required is enabled. Please notify [email protected] if you have questions or concerns or would like Pull Requests for metadata updates to merge automatically in future.

Fixing#970723 Remove ms.service = virtual-network. Replaced by ms.service = azure-virtual-network

Who initiated this PR?
The Learn Platform and Product (LPP) Site Experience team manages the Learn platform's reporting taxonomies that enable content analytics for OKR reporting and content portfolio management. Reporting taxonomy values populate metadata attributes.

We regularly review reporting taxonomies to ensure they are accurate, useful, and align to current business needs. Updates to reporting taxonomies and associated metadata make reports cleaner, easier to use, and more consistent.

Why are we updating ms.service/ms.subservice metadata?
Objective: Ensure ms.service attribute reliably reflects product affiliation.

Issues: 1. Currently, ms.service taxonomy values mix product and non-product concepts. Non-product concepts represent real reporting needs but aren't strictly about products. 2. Slugs (machine readable identifiers) don't reflect Microsoft branding guidelines. This is leading to inaccurate metadata on content.

Actions: 1. Revise taxonomy structure so "ms.service" represents the name of a branded Microsoft product, product family, or branding terminology. 2. Update slugs to comply with branding guidelines.

Outcome: 1. Establish a baseline for a comprehensive product data model representing all Microsoft offerings. 2. Ensure that report filters driven by ms.service will be based on product. 3. Improved metadata quality.

Why it matters

  • Efficiency in Content Auditing: Revising the taxonomy structure will enable more precise content audits, fostering repeatable business processes and alleviating the burden of large-scale, one-off audit projects.
  • Semantic Precision: The ms.service taxonomy will have meaningful, universally understood semantic values.
  • Consistent Metadata: This work contributes to the accuracy and uniformity of contextual metadata within the Learn Knowledge Base.
  • RAG Pipeline Efficiency: The Learn Knowledge Service's RAG pipeline will benefit from increased accuracy of product attribution of content.

How does this affect me?
After changes are complete, standard dashboards and reports will reflect new values, so you'll need to use new filter values. If you have any custom dashboards or Kusto queries, you might need to update those also.

Frequently Asked Questions
Why does this Pull Request appear to be made by the Repository Owner? We open Pull Requests two different ways.

  • For Git Repos with a permissioned Service Account, we open the PR from our Document Build Service Account.
  • For Git Repos that we either do not have Service Account permission for or the repo is in Azure Repos (ADO) we open the Pull Requests in an automated way with the PR creator as the Repo owner.

How can I revert a Pull Request that has been merged and created an unexpected issue? Whether a PR has been merged manually or automatically, you can revert it if an issue arises. See Reverting a pull request - GitHub Docs.

Copy link
Contributor Author

Learn Build status updates of commit 0b72126:

💡 Validation status: suggestions

File Status Preview URL Details
docfx.json 💡Suggestion Details

docfx.json

  • Line 124, Column 58: [Suggestion: value-deprecated-replace - See documentation] The 'ms.service: virtual-machines' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: azure-virtual-machines'.
  • Line 125, Column 57: [Suggestion: value-deprecated-replace - See documentation] The 'ms.service: virtual-machines' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: azure-virtual-machines'.
  • Line 173, Column 61: [Suggestion: value-deprecated-replace - See documentation] The 'ms.service: virtual-machines' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: azure-virtual-machines'.
  • Line 182, Column 55: [Suggestion: value-deprecated-replace - See documentation] The 'ms.service: virtual-machines' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: azure-virtual-machines'.
  • Line 183, Column 54: [Suggestion: value-deprecated-replace - See documentation] The 'ms.service: virtual-machines' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: azure-virtual-machines'.

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 learn-build-service-prod bot merged commit ed4d871 into main Aug 8, 2024
2 checks passed
@learn-build-service-prod learn-build-service-prod bot deleted the 9c34ee75-b995-408f-811f-90228fbf553a_81 branch August 8, 2024 05:08
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.

0 participants