Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request to update cross-links to ASP.NET Core docs #3004

Closed
guardrex opened this issue Sep 5, 2024 · 1 comment · Fixed by #3096
Closed

Request to update cross-links to ASP.NET Core docs #3004

guardrex opened this issue Sep 5, 2024 · 1 comment · Fixed by #3096
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@guardrex
Copy link
Contributor

guardrex commented Sep 5, 2024

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:

- https://docs.microsoft.com/en-us/aspnet/core/security/samesite?view=aspnetcore-3.1
+ https://learn.microsoft.com/aspnet/core/security/samesite

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

@guardrex 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 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 pmaytak added documentation Improvements or additions to documentation good first issue Good for newcomers and removed untriaged needs attention labels Oct 2, 2024
@guardrex
Copy link
Contributor Author

guardrex commented Oct 21, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants