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

Github link to book on doc.rust-lang.org is broken #633

Closed
jvns opened this issue Apr 17, 2017 · 4 comments
Closed

Github link to book on doc.rust-lang.org is broken #633

jvns opened this issue Apr 17, 2017 · 4 comments

Comments

@jvns
Copy link

jvns commented Apr 17, 2017

the "on github" link at https://doc.rust-lang.org/book/ is broken. The link seems to be correct in this repository and at http://rust-lang.github.io/book/first-edition/index.html so maybe the version on doc.rust-lang.org is just an old deploy or something?

@ScottAbbey
Copy link
Contributor

ScottAbbey commented Apr 18, 2017

I can answer the "Why?" but can't suggest how to fix it.

The first edition of the book lived at rust-lang/rust/src/doc/book for about 5 years. In March 2017 the docs team did some work to move some of the bookish resources to submodules. The link path was updated to point here when the change was made, but the docs at doc.rust-lang.org follow the stable/beta/nightly 6 week release schedule....the updated version won't hit https://doc.rust-lang.org/book for about 6 or 7 more weeks after today!

I have no idea if the link fix can be sent to the beta or stable release without sitting in nightly for 6 weeks.

You can view the current nightly version of doc.rust-lang.org at https://doc.rust-lang.org/nightly, where the links to the book are all a bit different, as the second edition will be published on the main site once the current nightly hits stable in a few weeks.

If you haven't read the book yet, I would recommend starting with the second edition. I read the first edition a few months ago and was a bit displeased to find out afterward that there was a second edition well along with more polish and better organization. It will eventually be published by No Starch Press, but isn't ready for printing yet.

The main authors have been working hard in recent weeks to get at least a draft of every chapter finished, and they are seeking any review and comments they can find. I keep asking them questions for clarification, and then they go fix up the appropriate section of the book as a result. As a result of their focus on the new edition, fixups requested here for the first edition are mostly going to be ignored for right now.

@jvns
Copy link
Author

jvns commented Apr 18, 2017

that is a good reason! seems totally fine to wait 6 weeks for it to be fixed :)

@jvns jvns closed this as completed Apr 18, 2017
@carols10cents
Copy link
Member

Hi @jvns!!! @ScottAbbey is right, beta is branching later this week so it'll be about 6 weeks until the page at https://doc.rust-lang.org/nightly/book/ is available on stable. Thank you for your patience!! It's not often that people are happy waiting 6 weeks for a fix ;)

@steveklabnik
Copy link
Member

Other good posts in this thread already, but

I have no idea if the link fix can be sent to the beta or stable release without sitting in nightly for 6 weeks.

beta yes; stable, not really. To fix stable requires putting out a brand-new release; to fix beta requires a backport, which we generally try not to do. It could make sense here; I might send in a PR....

frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 19, 2017
…lexcrichton

[beta] Fix link to book repo

This is a backport to beta, to be clear. I don't think we *have* to take this, but opened this PR to see if we should consider it to save six weeks of breakage.

Due to extracting the book out into its own repo, this link is broken. This fixes it to point to the right place. This was originally filed as rust-lang/book#633.
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

4 participants