You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello ... I noticed in some API comments that some of the links to the ASP.NET Core docs are pinning to specific versions of our articles. If there's a specific reason to pin to a given version (e.g., a cross-linked section only exists or on applies by version), it's fine. In most cases, however, we don't want to pin cross-links to stale, prior-release content. Here's a link that shows where these instances live ...
After that, the article version floats, and the article will load for the latest version. The culture floats, so the reader's preferred culture loads. The correct address prevents an unnecessary redirect.
Again, this request on pinning to a specific version only applies to when the API remarks don't pertain to a specific version of the article. Each API remark with a versioned cross-link has to be checked. I don't recommend updating them with a find-'n-replace gesture.
Reproduction steps
N/A
Error message
N/A
Id Web logs
N/A
Relevant code snippets
N/A
Regression
N/A
Expected behavior
N/A
The text was updated successfully, but these errors were encountered:
guardrex
changed the title
Don't pin article versions for cross-links to ASP.NET Core docs
Don't pin article versions and culture segments for cross-links to ASP.NET Core docs
Sep 5, 2024
guardrex
changed the title
Don't pin article versions and culture segments for cross-links to ASP.NET Core docs
Request to update cross-links to ASP.NET Core docs
Sep 5, 2024
@pmaytak ... Looks like from the labeling that you think this is low priority, but pinning the links to stale ASP.NET Core content is going to lead to problems for developers who don't pay attention the version after they follow a link. Would you like me to submit a PR to fix the problems?
UPDATE: I placed a PR for it that includes some other NIT link updates.
Microsoft.Identity.Web Library
Microsoft.Identity.Web
Microsoft.Identity.Web version
N/A
Web app
Not Applicable
Web API
Not Applicable
Token cache serialization
Not Applicable
Description
Hello ... I noticed in some API comments that some of the links to the ASP.NET Core docs are pinning to specific versions of our articles. If there's a specific reason to pin to a given version (e.g., a cross-linked section only exists or on applies by version), it's fine. In most cases, however, we don't want to pin cross-links to stale, prior-release content. Here's a link that shows where these instances live ...
https://github.com/search?q=repo%3AAzureAD%2Fmicrosoft-identity-web+%22%3Fview%3Daspnetcore-%22&type=code
All (or most) of these just need their query strings (e.g.,
?view=aspnetcore-3.1
) stripped off.Also, the culture segments (e.g.,
en-us
) should be dropped. There are many more of these ...https://github.com/search?q=repo%3AAzureAD%2Fmicrosoft-identity-web+%22en-us%22&type=code
... and the correct address now is "learn.microsoft.com." There are also many more of these to update ...
https://github.com/search?q=repo%3AAzureAD%2Fmicrosoft-identity-web+%22docs.microsoft.com%22&type=code
Example:
After that, the article version floats, and the article will load for the latest version. The culture floats, so the reader's preferred culture loads. The correct address prevents an unnecessary redirect.
Again, this request on pinning to a specific version only applies to when the API remarks don't pertain to a specific version of the article. Each API remark with a versioned cross-link has to be checked. I don't recommend updating them with a find-'n-replace gesture.
Reproduction steps
N/A
Error message
N/A
Id Web logs
N/A
Relevant code snippets
Regression
N/A
Expected behavior
N/A
The text was updated successfully, but these errors were encountered: