Skip to content

Conversation

@zachlute
Copy link
Contributor

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.

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'.
@dwijnand
Copy link
Contributor

dwijnand commented Sep 21, 2018

Are we concerned in breaking old URLs? Is there prior art for handling renamed doc pages?

@ehuss
Copy link
Contributor

ehuss commented Sep 21, 2018

Are we concerned in breaking old URLs?

I'd like to see some sort of redirects set up (including the renamed sections).

@zachlute
Copy link
Contributor Author

zachlute commented Sep 21, 2018

Ah, meant to ask about that and forgot. Yeah, the way I saw it there were a few options:

  1. Leave the pages the same and just change what they say. This is the easiest way to not break anything if we don't care that the names of the pages are still 'project'.
  2. Rename the pages and leave pages with the old names that just have a link to the new ones. This is a pretty straightforward manual redirect. Sections are harder. The only non-first section that got renamed was "The package layout." Everything else was at the top so shouldn't require any redirection if we can get people to the page. I'm not sure if it's possible to alias the section so any links to an old anchor still work?
  3. Not care if external links break. This is the current state and I agree it's not ideal.

Anybody have strong feelings about 1 or 2? Or some other option I'm not thinking of?

@ehuss
Copy link
Contributor

ehuss commented Sep 21, 2018

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.

@zachlute
Copy link
Contributor Author

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.

@zachlute
Copy link
Contributor Author

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?

@alexcrichton
Copy link
Member

@bors: r+

@bors
Copy link
Contributor

bors commented Sep 22, 2018

📌 Commit 9c8da17 has been approved by alexcrichton

@bors
Copy link
Contributor

bors commented Sep 22, 2018

⌛ Testing commit 9c8da17 with merge fd77d9d...

bors added a commit that referenced this pull request Sep 22, 2018
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.
@bors
Copy link
Contributor

bors commented Sep 22, 2018

💔 Test failed - status-travis

@bors
Copy link
Contributor

bors commented Sep 22, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing fd77d9d to master...

@bors bors merged commit 9c8da17 into rust-lang:master Sep 22, 2018
@zachlute zachlute deleted the project-to-package-docs branch September 24, 2018 16:37
@ehuss ehuss added this to the 1.31.0 milestone Feb 6, 2022
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

Successfully merging this pull request may close these issues.

5 participants