-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Replaced 'project' with 'package' in Cargo documentation. #6066
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
Conversation
I tried to make a distinction between places that were talking about Cargo 'projects' vs. a generic concept of a 'project' or a github 'project'.
|
Are we concerned in breaking old URLs? Is there prior art for handling renamed doc pages? |
I'd like to see some sort of redirects set up (including the renamed sections). |
|
Ah, meant to ask about that and forgot. Yeah, the way I saw it there were a few options:
Anybody have strong feelings about 1 or 2? Or some other option I'm not thinking of? |
|
There was a recent PR at #5975 that added redirects for the website that handled fragments. I'm not sure how difficult it would be to use a similar approach in mdbook, though. |
|
So, I've been thinking about this, and I think tonight I'm going to just do the thing in (1) where I update all the documentation but don't rename any of the files yet. That gets us most of the benefit of this change by making the documentation use the right terms and lets us delay figuring out the redirect problem until later. |
|
I reverted any of the changes that would case URLs or anchors to change. That means that one header still has to be called "The project layout" but everywhere else should be changed, so it's at least an improvement? |
|
@bors: r+ |
|
📌 Commit 9c8da17 has been approved by |
Replaced 'project' with 'package' in Cargo documentation. Partial fix for #6056. I tried to make a distinction between places that were talking about Cargo 'projects' vs. a generic concept of a 'project' or a github 'project'. It's entirely possible I was overzealous, so please tell me if some of these changes look dumb.
|
💔 Test failed - status-travis |
|
☀️ Test successful - status-appveyor, status-travis |
Partial fix for #6056.
I tried to make a distinction between places that were talking about Cargo 'projects' vs. a generic concept of a 'project' or a github 'project'. It's entirely possible I was overzealous, so please tell me if some of these changes look dumb.