Azure / azure-docs-sdk-dotnet

Repository for documentation on the Azure .NET SDK.
https://docs.microsoft.com/dotnet/api/?view=azure-dotnet
Creative Commons Attribution 4.0 International
89 stars 266 forks source link

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

Closed RetYn closed 3 months ago

RetYn commented 3 months ago

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 docs-allowlist-mgmt@microsoft.com. If you are not the correct contact for this content and repository, please notify Metadata-Management@microsoft.com.

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 Metadata-Management@microsoft.com if you have questions or concerns or would like Pull Requests for metadata updates to merge automatically in future.

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. 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.

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

Learn Build status updates of commit 29020c5:

:warning: Validation status: warnings

File Status Preview URL Details
api/overview/azure/latest/resourcemanager.containerregistry-readme.md :warning:Warning View (azure-dotnet) Details
api/overview/azure/preview/ai.inference-readme.md :warning:Warning View (azure-dotnet-preview) Details
docfx.json :warning:Warning Details

api/overview/azure/latest/resourcemanager.containerregistry-readme.md

api/overview/azure/preview/ai.inference-readme.md

docfx.json

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. 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:

RetYn commented 3 months ago

sign-off