Skip to content

Update ms.topic global metadata from "conceptual" to "concept-article"#5310

Merged
roji merged 2 commits intomainfrom
copilot/update-globalmetadata-ms-topic
Mar 27, 2026
Merged

Update ms.topic global metadata from "conceptual" to "concept-article"#5310
roji merged 2 commits intomainfrom
copilot/update-globalmetadata-ms-topic

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 27, 2026

Updates the ms.topic global metadata value in entity-framework/docfx.json to 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"
-      "ms.topic": "conceptual",
+      "ms.topic": "concept-article",

No .md or .yml files in this repo contain ms.topic: conceptual or ms.topic: article in frontmatter, so the docfx.json global 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 the globalMetadata value for ms.topic from "conceptual" to "concept-article".

Specific change

In entity-framework/docfx.json, in the build.globalMetadata section, change:

"ms.topic": "conceptual",

to:

"ms.topic": "concept-article",

What NOT to change

  • Do NOT modify any other docfx.json file — only entity-framework/docfx.json.
  • Do NOT modify any .md files (no .md files in this repo have ms.topic: conceptual or ms.topic: article in their frontmatter).
  • Do NOT modify any .yml files.
  • Do NOT change any other values in the docfx.json file — only the ms.topic value in globalMetadata.

Target branch

main

The 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: conceptual or ms.topic: article need that ms.topic value to be changed to ms.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:

  1. Scope of docfx.json change: You mentioned aspnet/docfx.json — I want to confirm this refers to the file at the path aspnet/docfx.json within the dotnet/EntityFramework.Docs repository, correct?

  2. Only .md files: Should I only modify .md files for the frontmatter changes, or are there other file types (e.g., .yml) that might also have ms.topic metadata?

  3. Exact matching: 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?

  4. Base branch: Should the PR target the main branch (or live branch)? 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.json has "ms.topic": "conceptual" in its globalMetadata section (line ~68). This needs to be changed to "ms.topic": "concept-article".

2. Markdown files with ms.topic in frontmatter — No changes needed ✅

I searched extensively for any .md files containing ms.topic: conceptual or ms.topic: article in their frontmatter and found none. The only .md file with an ms.topic frontmatter value is managed-identities-test-non-production.md, which has ms.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:

- "ms.topic": "conceptual",
+ "ms.topic": "concept-article",

Since the globalMetadata in docfx.json applies ms.topic: conceptual to 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 .md files override it with conceptual or article).

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.

  1. only change .md files for the frontmatter change, but notify me if you find .yml files that contain those ms.topic values.

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

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

  1. docfx.json: Only entity-framework/docfx.json — change "ms.topic": "conceptual" to "ms.topic": "concept-article" in globalMetadata.
  2. .md files: Find any with frontmatter ms.topic values of conceptual or article (with any whitespace variation) and change to concept-article.
  3. .yml files: Don't change them, but report back if any contain those ms.topic values.
  4. Target branch: main

From my earlier search, I found no .md files with ms.topic: conceptual or ms.topic: article in frontmatter — the global metadata in docfx.json covers all docs. But let me also check for .yml files before creating the PR.

Assistant: Good news on the .yml check — no .yml files 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.

@wadepickett wadepickett self-requested a review March 27, 2026 04:38
Copy link
Copy Markdown
Contributor

@wadepickett wadepickett left a comment

Choose a reason for hiding this comment

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

Approved.

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
Copilot AI requested a review from wadepickett March 27, 2026 04:38
Copy link
Copy Markdown
Contributor

@wadepickett wadepickett left a comment

Choose a reason for hiding this comment

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

Approved and verified no .md files with ms.topic values of conceptual or article.

@wadepickett wadepickett marked this pull request as ready for review March 27, 2026 04:41
@wadepickett wadepickett requested review from Copilot and tdykstra March 27, 2026 04:41
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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" in entity-framework/docfx.json.

@roji roji merged commit b9a934d into main Mar 27, 2026
7 checks passed
@roji roji deleted the copilot/update-globalmetadata-ms-topic branch March 27, 2026 07:32
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