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

Update the docs link #3078

Merged
merged 1 commit into from
Jun 3, 2020
Merged

Conversation

lindexi
Copy link
Member

@lindexi lindexi commented Jun 2, 2020

No description provided.

@lindexi lindexi requested a review from a team as a code owner June 2, 2020 09:58
@ghost ghost added the PR metadata: Label to tag PRs, to facilitate with triage label Jun 2, 2020
@ghost ghost requested review from fabiant3, ryalanms and SamBent June 2, 2020 09:58
@vatsan-madhavan
Copy link
Member

vatsan-madhavan commented Jun 2, 2020

@fabiant3 Is there an aka.ms or http://go.microsoft.com/fwlink/?LinkId= type link we can provide to @lindexi that will remain evergreen?

@lindexi
Copy link
Member Author

lindexi commented Jun 3, 2020

@vatsan-madhavan Thank you. Could you help me create the aka.ms type link? I don't have access to create it

@vatsan-madhavan
Copy link
Member

Could you help me create the aka.ms type link? I don't have access to create it

You wouldn't but MSFT folks can. But creating an aka.ms link doesn't help in itself. Maintaining the link is where the value comes. Usually, the owners of the target-URL are the ownes vested in maintaining these short URL's.

Links that use the go.microsoft.com/fwlink/?LinkId= system, for e.g., are permalinks maintained by the respective owners or docs teams that automatically forwards to the right language based on detected browser locale etc. In general, wherever possible, using locale agnostic permalinks are preferable, if they can be found.

If one of us creates an aka.ms or go.microsoft.com link newly for docs/typography, then it would suffer from the original problem. When the target url becomes defunct (sometime in the future, hypotheticallly), the short-url would also become useless (and would have to be updated). But if we could discover a pre-existing fwLink URL for docs/typography that's already being maintained by docs folks (or the typography folks etc.), then that would be more suitable for long-term use in this type of a PR.

All that said, its probably not worth slowing down/blocking too much here. If @fabiant3 can find a substitute easily, then great. Otherwise I think what you have here is pretty good and we should just merge it 👍

@fabiant3 fabiant3 merged commit 89cb348 into dotnet:master Jun 3, 2020
@fabiant3
Copy link
Member

fabiant3 commented Jun 3, 2020

Agreed with Vatsan here, this is good enough, I'm merging this in. Congrats on this pull request @lindexi .

@lindexi lindexi deleted the t/lindexi/fix-doc branch June 3, 2020 07:53
@ghost ghost locked as resolved and limited conversation to collaborators Apr 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
PR metadata: Label to tag PRs, to facilitate with triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants