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

Deduplicate doc URLs #24659

Closed
SimonSapin opened this issue Apr 21, 2015 · 16 comments
Closed

Deduplicate doc URLs #24659

SimonSapin opened this issue Apr 21, 2015 · 16 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority

Comments

@SimonSapin
Copy link
Contributor

There are at least three sets of URLs that give the same thing:

http://doc.rust-lang.org/std/
http://doc.rust-lang.org/nightly/std/
http://static.rust-lang.org/doc/master/std/

One of the should be picked and the others redirect to it.

Related, but I believe not quite duplicate: #9461, #12466, #14466, #18558.

CC @brson

@steveklabnik
Copy link
Member

The second are synonymous on purpose, and I'm not sure the third is even exposed anywhere, exactly

@tomjakubowski
Copy link
Contributor

Presumably /std/ will be (or redirect to) the stable channel docs, right?

@steveklabnik
Copy link
Member

Yes, once we have a stable channel :)

@SimonSapin
Copy link
Contributor Author

I’d like to revisit the decision to have URLs synonymous on purpose, which can be bad for search engines, and use redirects instead.

@steveklabnik
Copy link
Member

There's a second ticket open for rel=canonical, but I think that the reason that there can't be redirects is that they're just files on S3. /cc @alexcrichton

@SimonSapin
Copy link
Contributor Author

S3 seems to support redirects: https://aws.amazon.com/blogs/aws/amazon-s3-support-for-website-redirects/ (though I haven’t looked into details).

@alexcrichton
Copy link
Member

Last I looked into redirects they won't work for static.rust-lang.org, but that site is not linked from anywhere so I don't think that we should be worried about it. The other two I feel like are fine to have, we can use the rel=canonical trick to disambiguate, but I don't want either to go away.

@Valloric
Copy link
Contributor

Valloric commented Jul 2, 2015

I'll link to a comment I've made before about duplicate URL structures on rust-lang.org.

This is something you should strongly consider fixing.

@alexcrichton
Copy link
Member

alexcrichton commented Aug 22, 2016

cc @steveklabnik (and rest of the docs team, although there's no alias)

Right now we have stable docs available in two locations:

http://doc.rust-lang.org/std/
http://doc.rust-lang.org/stable/std/

On the infrastructure side we can make one redirect to the other. Does the docs team have a preference as to which is the canonical version?

@alexcrichton alexcrichton added the P-low Low priority label Aug 22, 2016
@edunham edunham added the A-docs label Aug 22, 2016
@tomjakubowski
Copy link
Contributor

Did you mean to say stable docs are available at /std/ and at /stable/std/? Or are the docs at /nightly/std/ docs for the stable distribution?

@alexcrichton
Copy link
Member

Oops, yes!

@steveklabnik
Copy link
Member

(and rest of the docs team, although there's no alias)

Let's try this: @rust-lang/docs

🎊

@steveklabnik
Copy link
Member

Does the docs team have a preference as to which is the canonical version?

So, there's actually three locations: there is also /current-version/std.

I think I prefer the longer one to be the canonical URL.

@frewsxcv
Copy link
Member

Relevant RFC: rust-lang/rfcs#1826

@steveklabnik steveklabnik added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Mar 10, 2017
@frewsxcv
Copy link
Member

frewsxcv commented Jun 8, 2017

Is there anything else actionable to do here?

@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 22, 2017
@frewsxcv
Copy link
Member

Now that the RFC I linked earlier has merged, a tracking issue has been opened, and as I see it, there's nothing else actionable in this particular issue so I'm going to close it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority
Projects
None yet
Development

No branches or pull requests

8 participants