Updating ms.topic for AI readiness #46448
Conversation
nathlaroche
requested review from
gewarren,
a team,
tdykstra,
adegeo,
IEvangelist,
tommcdon,
annelo-msft,
jsquire,
alexwolfmsft,
scottaddie,
christothes,
luisquintanilla,
JakeRadMSFT and
BillWagner
as code owners
dotnet-policy-service
bot
added
dotnet-azure/svc
dotnet-fundamentals/svc
dotnet-csharp/svc
fundamentals/subsvc
csharp-linq/subsvc
dotnet-framework/svc
dotnet-ml/svc
community-contribution
docfx.json
Outdated
| "docs/framework/configure-apps/file-schema/**/**.md": "reference", | ||
| "docs/framework/data/adonet/ef/language-reference/*-entity-sql.md": "language-reference", | ||
| "docs/framework/data/adonet/ef/language-reference/*.md": "language-reference", |
There was a problem hiding this comment.
Why was the -entity-sql dropped here?
There was a problem hiding this comment.
To follow the pattern on line 275 and to prevent updates to individual files. But I can bring it back to the previous value if you prefer.
There was a problem hiding this comment.
I think it was done purposely that way because not all the files are actually reference type articles. Example: https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/ef/language-reference/how-to-call-canonical-functions
docfx.json
Outdated
| @@ -255,7 +255,10 @@ | |||
| "_csharplang/**/*.md": "language-reference", | |||
| "_csharpstandard/**/*.md": "language-reference", | |||
| "_vblang/spec/*.md": "language-reference", | |||
| "docs/azure/**/**.md": "conceptual", | |||
| "docs/architecture/**/*.md": "concept-article", | |||
| "docs/azure/**/**.md": "article", | |||
There was a problem hiding this comment.
Not needed since it's the default, correct? (Here and in a few other places.)
There was a problem hiding this comment.
Agreed. I will remove any pattern that sets the ms.topic value to article in fileMetadata section.
|
@dotnet-policy-service agree company="Microsoft" |
| @@ -153,7 +153,7 @@ | |||
| "ms.author": "dotnetcontent", | |||
| "ms.devlang": "dotnet", | |||
| "ms.service": "dotnet", | |||
| "ms.topic": "conceptual", | |||
| "ms.topic": "article", | |||
There was a problem hiding this comment.
If the ms.topic of conceptual is going away, and the equivalent is concept-article, then I believe our default that we want is concept-article here.
| "ms.topic": "article", | |
| "ms.topic": "concept-article", |
There was a problem hiding this comment.
The equivalent to conceptual is not always "concept-article". If for this project, conceptual was used to mean: "Use for content that provides an in-depth explanation of functionality related to a service(s) that is fundamental to understanding and use." then we can definitely use it as a default value.
Most teams used "conceptual" as a catch-all; in this case it should be replaced with article.
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| title: Configure Visual Studio Code for Azure development with .NET | |||
| description: This article helps you configure Visual Studio Code for Azure development including getting the right plugins installed and configured in VS Code | |||
| ms.topic: conceptual | |||
| ms.topic: concept-article | |||
There was a problem hiding this comment.
I would be cautious about changing things to concept-article. That has a schema associated with it, which for example, disallows numbered lists. This article contains a numbered list and thus would be in violation of the article-type schema.
Summary
Phase 1 of updating ms.topic as discussed with @BillWagner.
Internal previews
Toggle expand/collapse
Note
This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.