Remove the original changelog #15123
Conversation
The changelog is now located in the cargo book.
rustbot
added
the
S-waiting-on-review
|
The other alternative is we patching every link in blog.rust-lang.org. Admittedly this won't fix other links in the wild. |
ehuss
changed the title
|
This should be ready to go now that the docs are up at https://doc.rust-lang.org/nightly/cargo/CHANGELOG.html.
I'm happy to post a PR to fix those links, too. |
Should that be a blocker of merging this? I am fine with either way. cc @epage, wonder what your thought is, as you were in the previous discussion. |
|
That works for those links but not for any others (bookmarks, browser history, links from issues, etc). If they land on a generic 404 page, that isn't great. It is probably fine for them to have to search within a page. Releases are easy to find. We didn't have anchors to specific items, so work for that was already needed. I also find that the first place I look for a changelog is by looking for a file in a repo root. I rarely think to check Releases. I'll likely miss it in the body of the text here. Options
|
The page isn't being removed. There is a placeholder that directs them to the new location.
This is the option I'm proposing here. The reason for not symlinking is that I would prefer to avoid having users assume they can look at that file on GitHub, since there is risk it won't render at all. I'd also like to make it easier to do relative links within the book (which can help with offline viewing, link validation, etc.). The reason I refrained from the fork-and-freeze approach is because I wanted to avoid having two copies of a large amount of content. It may be hard for the user to see a notice at the top of the page that it is no longer being updated if there is still a large amount of content displayed to the user. It also doesn't help with the "possibly doesn't render" problem. |
Sorry, I looked too closely and thought it was deleted. That should work. |
Update cargo 14 commits in 0e3d73849ab8cbbab3ec5c65cbd555586cb21339..2928e32734b04925ee51e1ae88bea9a83d2fd451 2025-02-01 20:14:40 +0000 to 2025-02-07 16:50:22 +0000 - Simplify backtrack (rust-lang/cargo#15150) - Don't use on Solaris libc::LOCK_* which were removed from libc in ver… (rust-lang/cargo#15143) - feat: emit error if package not found within workspace (rust-lang/cargo#15071) - Make cache tracking resilient to unexpected files (rust-lang/cargo#15147) - Small resolver cleanups (rust-lang/cargo#15040) - feat: add `cargo pkgid` support for cargo-script (rust-lang/cargo#14961) - Suggest similar feature names on CLI (rust-lang/cargo#15133) - fix: Don't use "did you mean" in errors (rust-lang/cargo#15138) - Fix changelog link (rust-lang/cargo#15142) - chore(deps): update rust crate rand to 0.9.0 (rust-lang/cargo#15129) - Remove the original changelog (rust-lang/cargo#15123) - chore(deps): update rust crate gix to 0.70.0 (rust-lang/cargo#15128) - allow windows reserved names in CI (rust-lang/cargo#15135) - removed a word that was repeated (rust-lang/cargo#15136)
<!-- Thanks for submitting a pull request 🎉! Here are some tips for you: * If this is your first contribution, read "Cargo Contribution Guide" first: https://doc.crates.io/contrib/ * Run `cargo fmt --all` to format your code changes. * Small commits and pull requests are always preferable and easy to review. * If your idea is large and needs feedback from the community, read how: https://doc.crates.io/contrib/process/#working-on-large-features * Cargo takes care of compatibility. Read our design principles: https://doc.crates.io/contrib/design.html * When changing help text of cargo commands, follow the steps to generate docs: https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages * If your PR is not finished, set it as "draft" PR or add "WIP" in its title. * It's ok to use the CI resources to test your PR, but please don't abuse them. ### What does this PR try to resolve? Explain the motivation behind this change. A clear overview along with an in-depth explanation are helpful. You can use `Fixes #<issue number>` to associate this PR to an existing issue. ### How should we test and review this PR? Demonstrate how you test this change and guide reviewers through your PR. With a smooth review process, a pull request usually gets reviewed quicker. If you don't know how to write and run your tests, please read the guide: https://doc.crates.io/contrib/tests ### Additional information Other information you want to mention in this PR, such as prior arts, future extensions, an unresolved problem, or a TODO list. --> ### What does this PR try to resolve? When Cargo's changelog was moved into the book in #15123, it seems the extension was left as `.md`, whereas the link should point to the rendered version, which ends with `.html`. ### How should we test and review this PR? Following the new link in the README's rendered view and observing that it does indeed point to the changelog should be enough.
This removes the original changelog now that it is located in the cargo book.
This places a notice in the original location that it has moved to a new place. There are a few other alternatives we could consider:
Keep the headings but replace the content with a link. This would make it a little easier for someone to jump to the exact position in the new page. However, it looks a little messy. Each section could be something like:
Keep the content, with a notice at the top that the page is no longer being updated. I was a little uncomfortable with this, since I wasn't sure people would see the notice, it duplicates some content, and still leaves the potential problems of GitHub not rendering the page. If we cut some content, it ensures the page still renders reliably.
Opening as draft until #15119 is published on nightly.