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

Reconsider deleting linux-instructions.md and related files #110324

Closed
richlander opened this issue Dec 2, 2024 · 4 comments · Fixed by #110332
Closed

Reconsider deleting linux-instructions.md and related files #110324

richlander opened this issue Dec 2, 2024 · 4 comments · Fixed by #110332
Assignees
Labels
documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Milestone

Comments

@richlander
Copy link
Member

I just noticed https://github.com/dotnet/runtime/pull/107415/files. It deleted a bunch of long-standing files. I expect it broke a ton of links. I've used those links from lots of places. The typical approach is to leave the files and then add links to the new place.

I noticed that there are lots of places within our own repo using the old links, such as https://github.com/dotnet/runtime/blob/main/docs/workflow/testing/coreclr/testing.md#requirements.

I'd like to see a follow-up PR to resolve this in some way.

@ivdiazsa

@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Dec 2, 2024
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

@ivdiazsa ivdiazsa added documentation Documentation bug or enhancement, does not impact product or test code and removed area-Meta untriaged New issue has not been triaged by the area owner labels Dec 2, 2024
@ivdiazsa ivdiazsa self-assigned this Dec 2, 2024
@ivdiazsa ivdiazsa added this to the 10.0.0 milestone Dec 2, 2024
@ivdiazsa
Copy link
Member

ivdiazsa commented Dec 2, 2024

Oh I thought I had fixed the changes with the links. Leaving the old files too in this case would be redundant and potentially confusing, so I believe the best approach is to look for the broken links and change them accordingly. I will take a look to find them, but if you could leave here in another comment a list of all the broken links you encounter, that would be awesome. Thanks for bringing this to my attention @richlander!

@richlander
Copy link
Member Author

@ivdiazsa
Copy link
Member

ivdiazsa commented Dec 2, 2024

I will have to disagree on that one Rich. We've had them for years, but that doesn't mean they can't get outdated or that they can't be replaced as the product evolves. The new versions are more complete and get rid of redundant information. But don't worry, I will treat this links fix as a priority as the main goal of the docs refactoring was to improve the experience, and broken links do the opposite.

@ivdiazsa ivdiazsa linked a pull request Dec 3, 2024 that will close this issue
@dotnet-policy-service dotnet-policy-service bot added the in-pr There is an active PR which will close this issue when it is merged label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants