dgrtwo / tidy-text-mining

Manuscript of the book "Tidy Text Mining with R" by Julia Silge and David Robinson
http://tidytextmining.com
Other
1.32k stars 805 forks source link

Set up auto-compiling on Travis to GitHub Pages #2

Closed dgrtwo closed 8 years ago

dgrtwo commented 8 years ago

I'd like to get the current HTML up on GitHub pages; it would be a great way to share work in progress and to review what most needs to be done. We could also have Travis build it automatically upon pushing.

There's a guide to GitHub + Travis here: I started doing this on the gh-pages branch but honestly got a little turned around. Putting Issue here as a suggestion to either of us when time and interest arises.

(Right now it is technically visible at the awful URL of http://varianceexplained.org/tidy-text-mining/_book/intro.html with zero CSS, which- yuck!)

juliasilge commented 8 years ago

Jenny has done this with her Happy Git with R site, so it is doable.

GitHub repo: https://github.com/jennybc/happy-git-with-r

We should get a URL!

juliasilge commented 8 years ago

Here's another example, with slightly different .travis.yml and scripts to build the book:

GitHub repo: https://github.com/csgillespie/efficientR Rendered site: https://csgillespie.github.io/efficientR/

What I really don't understand right now is why I can't get the book to build an index.html from the index.Rmd. Both of the above examples have them.

juliasilge commented 8 years ago

So I don't know that we're really at a stage where all of this will work, but there is some stuff that you need to do because this is your repo, @dgrtwo. You need to do the parts where you grant Travis write access to your GitHub repository. I believe you need to create a token and encrypt it on Travis, and then put it in .travis.yml.

Things still aren't quite set up to work yet, because

But... it's a start? :grimacing:

juliasilge commented 8 years ago

Also, I would just like to state for the record that a gh-pages branch always makes me feel like I have gone to an ALTERNATE UNIVERSE.

(It's the same repository. But what is here?! Something completely different!)

dgrtwo commented 8 years ago

Doing so now!

Incidentally it turns out that as of about a week ago you can use a doc/ folder instead of a gh-pages branch! Don't know if that would have helped

dgrtwo commented 8 years ago

Done in 0fea3c64921cbe3e3320192771b4f41be95b6f60

When will we know if it worked?

juliasilge commented 8 years ago

Well, I don't think it can build right successfully right now but we should at least be able to see it try to build, just like an R package. We should be able to see it here: https://travis-ci.org/dgrtwo/tidy-text-mining When I go there, it looks like the repo maybe isn't clicked "on" yet? Have you flipped the switch from off to on? I don't think I can do it (even though I have write access to the repo).

(Here is Jenny's Travis build for her bookdown site, just so we know what we'll eventually be looking to see.)

dgrtwo commented 8 years ago

OK I hit the start button and gave a test commit, so now it's off to the races.

This is gonna take a long time but I think we'll be able to set up the cache to stay around.

See my email earlier btw?

juliasilge commented 8 years ago

Ah, there is another part you need to do here on the repo for the custom domain. Change something in the settings to add tidytextmining.com: https://help.github.com/articles/adding-or-removing-a-custom-domain-for-your-github-pages-site/

dgrtwo commented 8 years ago

Done

juliasilge commented 8 years ago

I think this is good now, right? I'm going to close this.

dgrtwo commented 8 years ago

👍👍