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

Publish RFCs as mdbook to GitHub Pages. #2192

Merged
merged 3 commits into from
Oct 31, 2017

Conversation

frewsxcv
Copy link
Member

Spoke with someone at Rust Belt Rust who mentioned this idea (@mre 👋)
and decided to take a stab at it. I originally implemented this upstream
in the Rust source repository (by adding a git submodule and dynamically
generating the contents of the book there). But then then I spoke with
@steveklabnik and agreed that doing it in CI in this repository would be
a lot easier.

@frewsxcv
Copy link
Member Author

frewsxcv commented Oct 28, 2017

Can see an example of it here: https://frewsxcv.github.io/rfcs/

Assuming this is desired, Travis just needs to be enabled (which I have permissions to turn on) and the GitHub 'personal access token' needs to be registered in the Travis settings (which I think I can also do).

Spoke with someone at Rust Belt Rust who mentioned this idea (@mre 👋)
and decided to take a stab at it. I originally implemented this upstream
in the Rust source repository (by adding a git submodule and dynamically
generating the contents of the book there). But then then I spoke with
@steveklabnik and agreed that doing it in CI in this repository would be
a lot easier.
@frewsxcv
Copy link
Member Author

cc @rust-lang/docs

@frewsxcv frewsxcv changed the title Publish RFCs as mdbook to GitHub pages. Publish RFCs as mdbook to GitHub Pages. Oct 28, 2017
@Havvy
Copy link
Contributor

Havvy commented Oct 28, 2017

I was holding off on suggesting this thinking it'd be a lot more work, so I'm +100 on this.

@mre
Copy link

mre commented Oct 28, 2017

Oh wow! That is awesome @frewsxcv. Thanks for that. ❤️

@steveklabnik
Copy link
Member

This is great!

@rust-lang/core what do you think?

I think merging this as-is is fine; but I'd also like to extend it someday; for example, we could map RFCs to section headings corresponding to year, etc.

@Mark-Simulacrum
Copy link
Member

I'd pull the script out of Travis and into a separate file (could just be generate-book.sh or something like that). That way we'd make it easier for contributors to generate the book locally if they wanted to...

@alexcrichton
Copy link
Member

Seems fine by me!

@frewsxcv
Copy link
Member Author

I'd pull the script out of Travis and into a separate file (could just be generate-book.sh or something like that). That way we'd make it easier for contributors to generate the book locally if they wanted to...

Done!

@frewsxcv
Copy link
Member Author

Also, I take back what I said earlier. I do not have permissions to enable Travis CI for this repo, so someone else will have to do that for me.

https://travis-ci.org/profile/rust-lang

@carols10cents
Copy link
Member

Also, I take back what I said earlier. I do not have permissions to enable Travis CI for this repo, so someone else will have to do that for me.

I have the power! I enabled travis, turned on "build only if .travis.yml is present" and turned off branch updates and PR updates, since this really only matters for master. Let me know if anything else should be changed!

Love this btw!!

@carols10cents
Copy link
Member

We tested this out on a branch; deploying is using an ssh key that's added as a deploy key to this repo only and is encrypted in travis. The deploy worked! http://rust-lang.github.io/rfcs/ so this should start auto deploying when this gets merged to master!

@carols10cents carols10cents merged commit 3ba363d into rust-lang:master Oct 31, 2017
@carols10cents
Copy link
Member

DID YOU EVER KNOOOOWWWW THAT I'M @frewsxcv'S HEEEEERROOOO

@chriskrycho
Copy link
Contributor

Rust Belt Rust unconference discussion FOR THE WIN!!!!! (I was standing beside this conversation and got giddy about it just listening in and now here it is.)

@Centril Centril added the not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc. label Nov 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants