Update ms.topic global metadata from "conceptual" to "concept-article"#5310
Merged
Update ms.topic global metadata from "conceptual" to "concept-article"#5310
Conversation
…k/docfx.json Agent-Logs-Url: https://github.com/dotnet/EntityFramework.Docs/sessions/b12444a9-c8ad-4444-b08c-29b9a9cf2054 Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update ms.topic value in docfx.json
Update ms.topic global metadata from "conceptual" to "concept-article"
Mar 27, 2026
wadepickett
approved these changes
Mar 27, 2026
Contributor
wadepickett
left a comment
There was a problem hiding this comment.
Approved and verified no .md files with ms.topic values of conceptual or article.
There was a problem hiding this comment.
Pull request overview
Updates the DocFX global metadata for the EF Docs site to align with the Microsoft Learn taxonomy update by changing the default ms.topic value.
Changes:
- Updated
build.globalMetadata["ms.topic"]from"conceptual"to"concept-article"inentity-framework/docfx.json.
roji
approved these changes
Mar 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the
ms.topicglobal metadata value inentity-framework/docfx.jsonto align with the Microsoft Learn platform's updated taxonomy (contributes to dotnet/AspNetCore.Docs#36930).Change
entity-framework/docfx.json:globalMetadata["ms.topic"]:"conceptual"→"concept-article"No
.mdor.ymlfiles in this repo containms.topic: conceptualorms.topic: articlein frontmatter, so thedocfx.jsonglobal metadata is the only change needed.Original prompt
Context
This contributes to dotnet/AspNetCore.Docs#36930.
Change Required
In the file
entity-framework/docfx.json, update theglobalMetadatavalue forms.topicfrom"conceptual"to"concept-article".Specific change
In
entity-framework/docfx.json, in thebuild.globalMetadatasection, change:to:
What NOT to change
docfx.jsonfile — onlyentity-framework/docfx.json..mdfiles (no.mdfiles in this repo havems.topic: conceptualorms.topic: articlein their frontmatter)..ymlfiles.docfx.jsonfile — only thems.topicvalue inglobalMetadata.Target branch
mainThe following is the prior conversation context from the user's chat exploration (may be truncated):
User: The following contributes to: dotnet/AspNetCore.Docs#36930
In this repo dotnet/EntityFramework.Docs:
Any .md document with a frontmatter metada containing
ms.topic: conceptualorms.topic: articleneed that ms.topic value to be changed toms.topic: concept-article.If the ms.topic global metadata value in aspnet/docfx.json specifies a value of "conceptual" or article, it needs to be changed to a value of "concept-article".
Let me know if have any questions that would help with acuracy for this goal.
Assistant:
I have a few clarifying questions to ensure accuracy before creating the PR:
Scope of
docfx.jsonchange: You mentionedaspnet/docfx.json— I want to confirm this refers to the file at the pathaspnet/docfx.jsonwithin thedotnet/EntityFramework.Docsrepository, correct?Only
.mdfiles: Should I only modify.mdfiles for the frontmatter changes, or are there other file types (e.g.,.yml) that might also havems.topicmetadata?Exact matching: For the frontmatter in
.mdfiles, should I match bothms.topic: conceptualandms.topic: article(with possible whitespace variations likems.topic: conceptualwith extra spaces), and replace them all withms.topic: concept-article?Base branch: Should the PR target the
mainbranch (orlivebranch)? Let me check what the default branch is.Assistant: Based on my research, here's what I found for
dotnet/EntityFramework.Docs:Summary of findings
1.
docfx.json— Global metadata needs updating ✅The file
entity-framework/docfx.jsonhas"ms.topic": "conceptual"in itsglobalMetadatasection (line ~68). This needs to be changed to"ms.topic": "concept-article".2. Markdown files with
ms.topicin frontmatter — No changes needed ✅I searched extensively for any
.mdfiles containingms.topic: conceptualorms.topic: articlein their frontmatter and found none. The only.mdfile with anms.topicfrontmatter value ismanaged-identities-test-non-production.md, which hasms.topic: include— that value is not in scope for this change.The only change required
The single change needed is in
entity-framework/docfx.json:Since the
globalMetadataindocfx.jsonappliesms.topic: conceptualto all docs in the repo by default, changing it there effectively updates every document that inherits that value (which is all of them, since no individual.mdfiles override it withconceptualorarticle).Would you like me to create a pull request with this change?
User: 1. it is dotnet/EntityFramework.Docs/entity-framework/docfx.json only, no other docfx.json, no other repo.
only change .md files for the frontmatter change, but notify me if you find .yml files that contain those ms.topic values.
Yes For the frontmatter in .md files, should I match both ms.topic: conceptual and ms.topic: article (with possible whitespace variations like ms.topic: conceptual with extra spaces), and replace them all with ms.topic: concept-article
target the main branch. If there is no main branch then target live.
Assistant:
Thank you for the clarifications. Let me confirm my understanding before creating the PR:
docfx.json: Onlyentity-framework/docfx.json— change"ms.topic": "conceptual"to"ms.topic": "concept-article"in globalMetadata..mdfiles: Find any with frontmatterms.topicvalues ofconceptualorarticle(with any whitespace variation) and change toconcept-article..ymlfiles: Don't change them, but report back if any contain thosems.topicvalues.mainFrom my earlier search, I found no
.mdfiles withms.topic: conceptualorms.topic: articlein frontmatter — the global metadata indocfx.jsoncovers all docs. But let me also check for.ymlfiles before creating the PR.Assistant: Good news on the
.ymlcheck — no.ymlfiles in the repo contain `ms.topi...This pull request was created from Copilot chat.
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.