-
Notifications
You must be signed in to change notification settings - Fork 520
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
rename to rustc-dev-guide #470
Comments
👍, I was confused also by the book and the guide existence too. Actually, I'd rename both things and the names you proposed seem great. |
+1 from me, the renaming seems reasonable. |
Alas, users strike again. I've always felt computer science would be way more fun if we had no users... |
Does anyone know -- if I rename the repo, will links to the rendered format also redirect? |
All |
Yes, github will redirect the links. We should fix the following links in the guide itself, though: $ rg github.io/rustc-guide
README.md
6:[You can read the latest version of the guide here.](https://rust-lang.github.io/rustc-guide/)
src/important-links.md
14:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html)
15:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#updating-documentation)
16:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs)
src/implementing_new_features.md
181:[here]: https://rust-lang.github.io/rustc-guide/stabilization_guide.html
src/tests/running.md
126:[mode]: https://rust-lang.github.io/rustc-guide/tests/adding.html#tests-that-do-not-result-in-compile-errors Additionally, we will probably have broken links in the rust-lang/rust and rust-lang/forge repos in some readmes, I think... |
👍 for renaming. |
I'm generally against renaming, as I think it will cause a lot of headaches. IMHO, those in favor of renaming should find the links that are going to break and make a list so that we can fix them. |
Should we worry about anything outside https://github.com/search?q=org%3Arust-lang+rust-lang.github.io%2Frustc-guide&type=Code? |
@tshepang Perhaps we make the old address redirect to the new one or add a link like "are you looking for the rustc-dev-guide? Click here" |
And we should maybe make a blog post |
@mark-i-m if that's all the links we care for, won't we get redirects for free, then fix such links at our leisure? |
@tshepang No I don't think so. TMK, Github only redirects links under github.com, not GitHub pages. That's why the forge has a manual list of redirects... |
If we are trying to address subtle differences in names, maybe we should spell out “rust compiler dev guide” rather than rely on the single letter “c” for the distinction between “Rust development” and “rustc development”? |
FWIW, I feel like enough of these links are already spread across codebases, issues and bookmarks that redirects should be set up. |
Agreed. It's probably worth putting up a site that gives the user an option between the compiler guide and rustc-dev-guide... |
@RalfJung We added this to the transition tasks. We are planning to make the transition on Monday. We still need to identify someone who can rename the |
@chrissimpkins One other thing... it's probably worth making announcements on internals and Inside Rust blog about the transition... |
Thanks @mark-i-m. I added both as tasks in our list. Will do! |
…p1995 Update rustc-guide to rustc-dev-guide The rustc-guide is being renamed to the rustc-dev-guide. The discussion is in rust-lang/rustc-dev-guide#470. This PR revises rustc-guide to rustc-dev-guide in the Readme Markdown file. Transition tracker: rust-lang/rustc-dev-guide#602
…p1995 Update rustc-guide to rustc-dev-guide The rustc-guide is being renamed to the rustc-dev-guide. The discussion is in rust-lang/rustc-dev-guide#470. This PR revises rustc-guide to rustc-dev-guide in the Readme Markdown file. Transition tracker: rust-lang/rustc-dev-guide#602 changelog: none
The guide was renamed. Tracking issue #602 for more context. |
…etroalbini Rename rustc guide This is in preparation for rust-lang/rustc-dev-guide#470 Needs to be merged after we actually rename the guide. Have used this to rename: `git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'` `git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'` `git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
…etroalbini Rename rustc guide This is in preparation for rust-lang/rustc-dev-guide#470 Needs to be merged after we actually rename the guide. Have used this to rename: `git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'` `git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'` `git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
…etroalbini Rename rustc guide This is in preparation for rust-lang/rustc-dev-guide#470 Needs to be merged after we actually rename the guide. Have used this to rename: `git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'` `git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'` `git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
I propose we rename this repo to the rustc-dev-guide, to avoid confusion with the "rustc book" (and maybe we ought to rename that to the "rustc user's manual" or something, but that's a separate topic).
cc @rust-lang/compiler @rust-lang/wg-learning
The text was updated successfully, but these errors were encountered: