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

Replace the Tutorial with the Guide. #16657

Merged
merged 2 commits into from
Sep 12, 2014

Conversation

steveklabnik
Copy link
Member

The Guide isn't 100% perfect, but it's basically complete. It's
certainly better than the tutorial is. Time to start pointing more
people its way.

I also just made it consistent to call all things 'guides' rather than
tutorials.

Fixes #9874. This is the big one.

And two bugs that just go away.

Fixes #14503.
Fixes #15009.

@huonw
Copy link
Member

huonw commented Aug 21, 2014

This kills all links to the tutorial over the internet; maybe it could be replaced with a more graceful "deprecation" page?

@steveklabnik
Copy link
Member Author

That's true. We may want to leave that up for a bit. Previous things just got nuked, but it might be nice to be more graceful here.

@steveklabnik
Copy link
Member Author

@huonw fixed, at least the basics. what do you think?

@@ -8,7 +8,7 @@ li {list-style-type: none; }
</style>

* [A 30-minute Intro to Rust](intro.html)
* [The Rust tutorial](tutorial.html) (* [PDF](tutorial.pdf))
* [The Rust guide](guide.html) (* [PDF](guide.pdf))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, wait; I see you've adjusted the PDF generation above.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! and the link won't work until this all gets generated.

@steveklabnik
Copy link
Member Author

@brson this one is good to go, though 😉 😄

@adrientetar
Copy link
Contributor

You have added the new guide to LaTeX PDF build rules instead of the tutorial but it can’t build it properly, I’d say it’s hitting #12804.

@steveklabnik
Copy link
Member Author

It builds properly locally.

@adrientetar
Copy link
Contributor

Incl. LaTeX PDF docs? (it’s optional) Are you using pdflatex as a compiler?

@steveklabnik
Copy link
Member Author

yup.

@steveklabnik
Copy link
Member Author

Rebased to remove the (odd) merge conflict.

I still have no idea why this works for me but fails on the buildbot. Can anyone help?

@brson
Copy link
Contributor

brson commented Sep 9, 2014

Awesome news! I can't reproduce this on the bots...

@brson
Copy link
Contributor

brson commented Sep 9, 2014

Oh, wait. I can. WTF.

@brson
Copy link
Contributor

brson commented Sep 9, 2014

For some reason, the build succeeded the first try. On the second try, guide.pdf does get created, but the build still fails.

@brson
Copy link
Contributor

brson commented Sep 9, 2014

And that time the build succeeded...

@brson
Copy link
Contributor

brson commented Sep 9, 2014

Oh, I see what's happening. Because the build failure leaves guide.pdf on disk, subsequent runs succeed.

@steveklabnik
Copy link
Member Author

Rebased off of HEAD again

@brson
Copy link
Contributor

brson commented Sep 9, 2014

pdflatex gives no indication what the error is. both things that it prints appear to be 'normal'; just returns an error code of 1 for mysterious reasons.

@brson
Copy link
Contributor

brson commented Sep 9, 2014

Ah, indeed the problem is #12804. If you run pdflatex not in 'batchmode' it prints

! Package inputenc Error: Unicode char \u8:π not set up for use with LaTeX.

See the inputenc package documentation for explanation.
Type  H <return>  for immediate help.

@steveklabnik
Copy link
Member Author

Oh iiiiinteresting. That'd be why I couldn't fix it locally, because I had a guide.pdf.

@brson
Copy link
Contributor

brson commented Sep 9, 2014

I'm preparing the patch @adrientetar suggests, preferring lualatex to pdflatex. Need to make sure the snapshot bots understand luatex.

@brson
Copy link
Contributor

brson commented Sep 10, 2014

The dist/snap bots have xalatex, not lualatex, and it seems to not work correctly, so more work to do.

@huonw
Copy link
Member

huonw commented Sep 10, 2014

This would also be fixed by #16300/#16991 by allowing the guide to type $\pi$ instead of the unicode character.

@steveklabnik
Copy link
Member Author

@huonw while that's true, handling unicode characters is still very, very useful.

@huonw
Copy link
Member

huonw commented Sep 10, 2014

I don't disagree, but this provides a low-automation way to land this. :)

bors added a commit that referenced this pull request Sep 11, 2014
Bugs in pdflatex (#12804) are preventing the guide from landing (#16657). This solves the immediate problem by changing the build system to prefer lualatex, xelatex to pdflatex (which is apparently obsolete). Because the xelatex on the snapshot bot seems to completely ignore the `-output-directory` option, I also had to frob the makefiles a bit for that case.
@brson
Copy link
Contributor

brson commented Sep 11, 2014

Needs rebase.

The Guide isn't 100% perfect, but it's basically complete. It's
certainly better than the tutorial is. Time to start pointing more
people its way.

I also just made it consistent to call all things 'guides' rather than
tutorials.

Fixes rust-lang#9874. This is the big one.

And two bugs that just go away.

Fixes rust-lang#14503.
Fixes rust-lang#15009.
@steveklabnik
Copy link
Member Author

Foiled by my own PR!

Updated.

bors added a commit that referenced this pull request Sep 12, 2014
The Guide isn't 100% perfect, but it's basically complete. It's
certainly better than the tutorial is. Time to start pointing more
people its way.

I also just made it consistent to call all things 'guides' rather than
tutorials.

Fixes #9874. This is the big one.

And two bugs that just go away.

Fixes #14503.
Fixes #15009.
@bors bors closed this Sep 12, 2014
@bors bors merged commit c456cca into rust-lang:master Sep 12, 2014
@steveklabnik steveklabnik deleted the goodbye_tutorial branch October 25, 2017 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants