Installing-rust proposed changes #24400
Conversation
Added Keyfile in Docs for documentation purposes.
Changed quite a bit. Here's a quick rundown: Multirust takes the center stage of rust installation and version management. I'm planning on adding an "Advanced MultiRust Configuration" section or page for the rest of the README.md for multirust either tonight or tomorrow. I also included uninstall instructions and rephrased (aka took extreme liberties) with the mannerisms of the document. I thought some of the vernacular made us sound a bit snobby or rushed (s/Congrats/Yay!) Documentation and where to find it has been moved to the forefront of the installation page. In the past I have found it tedious to try and collect the relevant information for a project, hopefully this format will put what information is available up front so people can get it BEFORE installing. All of the completely removed segments have made another appearance in the document. I haven't removed any pertinent information. I also added the location of the public PGP key and dropped a copy of it in ../doc/trpl/pgp.key I didn't see it otherwise in the document. In regards to taking liberties with including multirust 5:23PM steveklabnik: Lurkin: i asked brson about doing that and he said it wasn't ready for that kind of prime time yet Personally I think it's better than the self admittedly sketchy $ sudo curl -fs /git/rust | install.sh, I think it's even better if we remove the sketchy awareness from the first page of the book so it doesn't look like y'all built this thing on sand. I am "Lurkin" on IRC.
Added pgp.key to ./src/doc/trpl/pgp.key Added multirust install options, I kept all of the other install methods, they are just moved around and expanded on. Added place holder file for (../doc/trpl/multirust_advsetup.md), I will transfer brsons README.md after I get permission to do so. 5:23(4/13/2015)Lurkin steveklabnik ***PARAPHRASED***Multirust is better than what we have now by a thousand fold.***END_PARAPHRASE*** 5:23(4/13/2015)steveklabnik Lurkin: i asked brson about doing that and he said it wasn't ready for that kind of prime time yet IMHO multirust is a much needed more professional installer. I don't think parts of the first page of the book should be acknowledging the fact that we're asking new users to trust us as literally the first command. I included these instructions but AFTER the windows installation and AFTER the multirust instructions because again in my very humblest of opinions they should be deprecated and never spoken of again. PGP is a plenty fine way to sign the files, we really ought to include a checksum. (Maybe we do) I added the subreddit address to the bottom, I added uninstall files for multirust, I added the default installation file
Forgot uninstall for non awesome multirust configuration.
Placeholderfile
Formatting Replaced arch's with "architecture's" in first paragraph.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @pcwalton (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see CONTRIBUTING.md for more information. |
|
☔ The latest upstream changes (presumably #24481) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Hey @rundrop1 ! Finally getting around to this, sorry. I'm gonna read through now and comment inline |
| install Rust, but the easiest is to use the `rustup` script. If you're on Linux | ||
| or a Mac, all you need to do is this (note that you don't need to type in the | ||
| `$`s, they just indicate the start of each command): | ||
| install Rust, but first we ought to go over the officially supported architecture's. |
There was a problem hiding this comment.
This would not have the apostrophe.
There was a problem hiding this comment.
I'm not totally sold on putting this first, but I'm also not against it exactly. Hm.
There was a problem hiding this comment.
Hello Steve! I put it this way because I think the first question one might ask when looking through product documentation is "Will Rust work for me?" I think setting the scope of things currently supported is a good place to start the conversation, if I was trying to sell Rust I would start by saying how it already works with what folks have and why it not only augments but streamlines their current production environment. It's only in this order for that sort of anecdotal reason.
There was a problem hiding this comment.
Yeah I think that's reasonable.
|
Okay! I think overall these changes are good, and there will need to be some degree of workshopping some of the language, but first, the bigger questions: does @brson want multirust linked here? |
|
I'm going to close this out of inactivity, but feel free to reopen with a rebase and @steveklabnik's comments addresed! |
|
I have a copy of this on local that's modified, I can't figure out how to merge the new fork with the old one, brson also doesn't think multirust is ready for windows and since we're supporting all environments equally it no longer seamed pertinent to include it as it's "above my paygrade" to say otherwise. I'm still working on the rustdocs, just not on IRC all that much it's a big distraction. |
Hello Rustaceans!
Added:
Multirust basic installation and uninstallation information.
PGP.key to /trpl/pgp.key
Added multirust_advancedsetup.md placeholder file (It will cover toolchains, directories, pinning, etc)
I will fill multirust_advancedsetup.md tomorrow if brson and steveklabnik (The only two I know of, haven't met the rest yet) give their graces.
Changed:
Order of the document
Major -Documentation can now be found, read, and downloaded before installation.(Yeah right)
-Added supported architectures in the beginning
-Moved the less optimal install option below the .msi and *nix instructions
Minor-Vernacular and phrasing changes keeping in line with the spirit of the current document (optimistic, confident, welcoming)
Removed
Major -Removed the "Rightly angry about insecure install instructions"
5:23(4/13/2015)steveklabnik Lurkin: i asked brson about doing that and he said it wasn't ready for that kind of prime time yet
I think it's better than the alternative, my opinion doesn't really matter because this is my second pull request and this is involving steveklabnik's baby. (I am "Lurkin" on the IRC channels)