Move documentation to a book format #2448
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This moves the documentation in the README to a dedicated book with mdbook. This includes some new content and edits with the intent of better organizing the content and hopefully make it easier for new users. The changes are split in separate commits so you can see the content changes (the first commit should not have any content changes).
A preview can be seen at https://ehuss.github.io/rustup/. Or, you can check out this PR and run
mdbook serve
in thedoc
directory.CI is configured to deploy to GitHub pages on each push to master. This should appear on https://rust-lang.github.io/rustup/. BEFORE MERGING, the github-pages needs to be enabled on the repository. Settings → scroll down to "GitHub Pages" → set source to the "gh-pages" branch → click "Save".
It should be relatively easy to use a custom domain if we want (like rustup.rust-lang.org?), but that would require infra to help.
In the future, the CI can probably be changed to only publish on stable (or possibly some manual mechanism). In the short term, I think publishing from master will be better since there might be changes that will be needed before the next release (and performing the initial publish).
Closes #2396