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

rename to rustc-dev-guide #470

Closed
nikomatsakis opened this issue Oct 17, 2019 · 20 comments
Closed

rename to rustc-dev-guide #470

nikomatsakis opened this issue Oct 17, 2019 · 20 comments

Comments

@nikomatsakis
Copy link
Contributor

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

@spastorino
Copy link
Member

👍, 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.

@JohnTitor
Copy link
Member

+1 from me, the renaming seems reasonable.

@mark-i-m
Copy link
Member

Alas, users strike again. I've always felt computer science would be way more fun if we had no users...

@nikomatsakis
Copy link
Contributor Author

Does anyone know -- if I rename the repo, will links to the rendered format also redirect?

@eddyb
Copy link
Member

eddyb commented Oct 17, 2019

All github.com links will redirect but github.io ones won't.

@mark-i-m
Copy link
Member

mark-i-m commented Oct 17, 2019

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...

@michaelwoerister
Copy link
Member

👍 for renaming.

@mark-i-m
Copy link
Member

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.

@tshepang
Copy link
Member

@mark-i-m
Copy link
Member

@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"

@mark-i-m
Copy link
Member

And we should maybe make a blog post

@tshepang
Copy link
Member

@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?

@mark-i-m
Copy link
Member

@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...

@pnkfelix
Copy link
Member

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”?

@RalfJung
Copy link
Member

RalfJung commented Mar 6, 2020

FWIW, I feel like enough of these links are already spread across codebases, issues and bookmarks that redirects should be set up.

@mark-i-m
Copy link
Member

mark-i-m commented Mar 6, 2020

Agreed. It's probably worth putting up a site that gives the user an option between the compiler guide and rustc-dev-guide...

@chrissimpkins
Copy link
Member

chrissimpkins commented Mar 7, 2020

FWIW, I feel like enough of these links are already spread across codebases, issues and bookmarks that redirects should be set up.

@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 rustc-guide repository to rustc-dev-guide and set up a new rustc-guide repository to support the redirects.

@mark-i-m
Copy link
Member

mark-i-m commented Mar 7, 2020

@chrissimpkins One other thing... it's probably worth making announcements on internals and Inside Rust blog about the transition...

@chrissimpkins
Copy link
Member

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!

bors added a commit to rust-lang/rust-clippy that referenced this issue Mar 9, 2020
…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
bors added a commit to rust-lang/rust-clippy that referenced this issue Mar 9, 2020
…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
@spastorino
Copy link
Member

The guide was renamed. Tracking issue #602 for more context.

Centril added a commit to Centril/rust that referenced this issue Mar 11, 2020
…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'`
Centril added a commit to Centril/rust that referenced this issue Mar 11, 2020
…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'`
Centril added a commit to Centril/rust that referenced this issue Mar 12, 2020
…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'`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

10 participants