imathis / octopress

Octopress is an obsessively designed framework for Jekyll blogging. It’s easy to configure and easy to deploy. Sweet huh?
http://github.com/imathis/octopress
9.31k stars 2.62k forks source link

Reproducible websites with octopress #1459

Closed TheChymera closed 8 years ago

TheChymera commented 10 years ago

Hi, what brought me to octopress was my interest in producing blogs which can be cited in (at least semi-)scientific literature. If this idea generally interests you - you may find a lengthier description of my concept on one of my websites.

The main prerequisites for this are:

I seem to be having some issues with reproducible content, though. I would like to make it as easy as possible for any user to get my website on his machine. My vision for this is:

pull octopressinstall octopressinstall theme (if any) → pull my contentgenerate

How I currently do this is that I have repositories with ONLY the original (or git-relevant) content of my website - as seen here.

The problems here are:

  1. It's cumbersome to create an only-original-content repo (for instance for users who would like to contribute). one has to manually git rm --cached all the irrelevant files.
  2. Pulling my content on top of the Octopress install (which is itself a git repo with only some of the files committed) is also not particularly easy. One has to commit all the files about to be changed and things can get a bit disorganized when merging non-binary files (most prominently /source/favicon.png) fails.

I would be interested to hear your thoughts on this; and it would be great if you had any suggestions on how to streamline this process!

You may also be interested: @dengemann @gpoore @obtitus

parkr commented 10 years ago

If you just version control your source/ directory, that should work.

TheChymera commented 10 years ago

That's not enough to replicate my website /_config.yml for instance also needs to be committed, and I may have style-specific changes in /sass. Also, /source contains a lot of redundant files of which you would have a newer, better (though content-wise irrelevant) version when you pull octopress. Also, you still get merge issues with /source/favicon.png that way.

Any other ideas?

TheChymera commented 10 years ago

I simplified reproducing octopress websites a bit, and posted the respective instructions on my blog repositories' README pages (for instance my tutorials blog, my photography blog, and my neuroenhancement blog).

I'm still very happy to hear about suggestions for further streamlining, and of course, it would be great if you just go ahead and steal my websites ;) and tell me if you run into any issues.