Skip to content

Move 'Installing from source' contents from rust-lang repo README to forge #711

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

Closed
wants to merge 2 commits into from

Conversation

crlf0710
Copy link
Member

@crlf0710 crlf0710 commented Dec 5, 2023

This is cut-paste from the original README.md.

cc rust-lang/rust#118627

@rustbot
Copy link
Collaborator

rustbot commented Dec 5, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @pietroalbini (or someone else) soon.

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 5, 2023
@ehuss
Copy link
Contributor

ehuss commented Dec 5, 2023

My personal opinion is that this does not belong in the forge. The forge is mostly geared towards members of the rust-lang org, not users. This also seems like it would significantly increase the risk of it getting out of date, and increase the hassle when a PR changes something that requires updating these instructions. Would it be possible to keep this in rust-lang/rust in a separate file?

@crlf0710
Copy link
Member Author

crlf0710 commented Dec 5, 2023

But the "Other Installation Methods" chapter is already here. Do you feel there's major difference between those? Or is the other chapter better find a new home somewhere? @ehuss

@ehuss
Copy link
Contributor

ehuss commented Dec 5, 2023

I agree that the "Other installation methods" page probably needs a better home (since it is the only user-centric page in this book), but where that is isn't clear. I have considered creating a dedicated book on "installing rust", but I also lament that it seems like a failure if installing rust is so complicated it needs its own documentation.

In particular, that documentation is generally not version-specific (in that it doesn't really change much from version to version). However, the documentation proposed in this RFC will be version specific, and I think should be kept in the source tarball that the user downloads, so they can inspect the instructions directly inside it, and so that it is current for the version that they have. In the forge, there would not be a way to easily have different instructions for different versions.

@crlf0710 crlf0710 closed this Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants