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

Move documentation to a book format #2448

Merged
merged 10 commits into from
Aug 17, 2020
Merged

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Aug 6, 2020

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 the doc 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

@kinnison
Copy link
Contributor

I really like this approach and I think the CI looks good. Sorry it took so long for me to come to this. You have a conflict on README because of changes since you made your branch. I wonder if @rbtcollins has any reason to say this wouldn't be a good path to improving docs? If not, then a rebase and incorporation of whatever change is conflicting into your split docs will be needed before we can merge. 👍 on the approach from me.

@kinnison
Copy link
Contributor

@ehuss if you're able to solve the conflict (incl. updating anything into your split content) then we can merge 🎉

@ehuss
Copy link
Contributor Author

ehuss commented Aug 17, 2020

I have rebased.

@kinnison kinnison merged commit c9bdbc0 into rust-lang:master Aug 17, 2020
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

Successfully merging this pull request may close these issues.

Switch documentation to a book format?
3 participants