anarosner / headwaters

Scripts to retrieve and aggregate data for flow analysis, including: flow observations; weather timeseries and climate normals; and basin characteristics and impoundment info.
http://anarosner.github.io/headwaters
Other
0 stars 0 forks source link

GitHub Pages #1

Open djhocking opened 10 years ago

djhocking commented 10 years ago

I'm not sure if you've looked into GitHub pages but you can choose a template to create the basic layout for the site.

https://pages.github.com/

Here's the quick example I set up for the temperatureProject repo: http://conte-ecology.github.io/temperatureProject/

anarosner commented 10 years ago

Yes, I have tried out github pages. I'm mostly interested in using them to display rendered, knit r analyses, for which I don't want to use a template. But, for a "splash page" and description stuff, the templates are nice.

Dan, I wanted to follow up with you on the issue we talked about re github pages a few weeks ago. I was trying to set up the gh-pages branch to pull certain updates from the master branch. But, using checkout --orphan gh-pages, it seemed like, with the branch being orphaned and all, we were then no longer able to pull updates from the master branch. This is really counter-intuitive to me (what the advantage, then, or it being in the same repo? it seems like you're supposed to copy things into the local directory, but that's not very compatible with switching branches, which changes the local file directory.) You said there was a group at UNH that you were going to ask about it? Have you gotten any insights from them?

Unless I can find out something new, my inclination now is to have a separate repo for gh-pages. I'm also thinking it would make sense for the this repo to host rendered, knit rmd and md from both my package repo and analysis repo, as well as description/documentation on that whole cluster of repos that compose the modeling project. I'm a little afraid that this cross-over will make things messy, but on the other hand I like the idea of having a general page to describe the whole.

If anyone else has tips on setting up the gh-pages branch, they'd be much appreciated.

Thanks, Ana

anarosner commented 10 years ago

Not sure where to write this, since there have been gh-pages related discussion under multiple repos' issues. But, I'll put it here.

I've put up some working drafts on github pages.
http://anarosner.github.io/headwaters/

Basically, I used automatic page generator to create the gh-pages for the headwaters (main/package) repo. I knit some rmd files in my headwaters_sdoah and headwaters_ct_river repos, put them in gh-pages branches in each respective repo. Then, I link to those analysis knit pages from the headwaters repo gh-pages. This way the analysis rmd documents can live in their own repos, but you can find them all from the headwaters repo page.

I like the idea of using the automatic page generator, but I'm not sure I like it in practice. I have some questions about it, which I can bring up later. I haven't get gotten into the rebasing issue for the gh-pages for the analysis repos. To come, I'm sure.

You can take a look at the css for the knit rmd files if you want. My aim was to make the sections, code, and output more readable (since I found it hard to read the default rendering). I'm open to aesthetic changes. What I did with the css is a hack (I basically am making h1 and h3 look like divs) but it works, it let's me make the html generated by knit look how I want.

Let me know what you think.

Thanks, Ana