Fix or remove broken links in release-notes.md #380
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the past, release notes files were created per-release, but those have all been deleted - the earliest such release was 2.5, old enough that I didn't feel it was necessary to dig through history and find those notes and restore them, but just deleted the broken links. Old javadoc links apparently used `.` instead of `/` delimiters for packages, and left off `.html` suffixes. In theory our server will automatically deal with the missing suffixes, but won't rewrite paths. Going back to 1.x days, some documentation was written by adding inner classes to a DeveloperGuide class, and adding notes there. I've found the present-day equivelents of each of those old documents, or just deleted the links where nothing seemed appropriate.
|
As with #379, these broken links were found with tooling that I hope to add to the build once we have no more broken links. A case can be made for updating the code.google.com links - all were responding with 500 when I first started this process, but seem to be stable again (edit: back to 500 again, at least for some of them). As all issues have migrated to github we could consider rewriting those links, but I personally would be leaning to just remove them instead. |
FrankHossfeld
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the past, release notes files were created per-release, but those have all been deleted - the earliest such release was 2.5, old enough that I didn't feel it was necessary to dig through history and find those notes and restore them, but just deleted the broken links.
Old javadoc links apparently used
.instead of/delimiters for packages, and left off.htmlsuffixes. In theory our server will automatically deal with the missing suffixes, but won't rewrite paths.Going back to 1.x days, some documentation was written by adding inner classes to a DeveloperGuide class, and adding notes there. I've found the present-day equivelents of each of those old documents, or just deleted the links where nothing seemed appropriate.