goatpig
Clean up gh-pages repo
- http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/ states that only apps should have the lock file checked into repos. Gems don't care, and this is a moving target anyway. Delete Gemlock files.
- Update Jekyll config. Jekyll must be >= 3.5.0.
- Update README.
AFAIK, this file just interferes with people who are attempting to generate the Armory web page locally. My Gemfile.lock was radically different once I finally got everything running. So, unless I'm missing something (and I can't find any good docs indicating otherwise), this file should go.
Also, as usual, I'm adding stuff as I go. :) I'm marking this PR as a WIP for now, mainly because I want to test a couple of things that should be safe.
@achow101 - Would you mind sanity checking this PR? I tested on macOS and Ubuntu, and can test on WSL if desired. @goatpig - I added sections in the README regarding copyright and licensing. I took an educated guess regarding the status. Please double check what I wrote and let me know if I need to make any changes. Perhaps the site should be distributed under the Copyleft license? I suppose there may also need to be some statement regarding any ATI property, if any (e.g., the logo).
The site builds so that's fine. Not quite sure about some things in the README.
It might be useful to mention in the readme that I handle a lot of the website stuff.
Fixup complete.
@achow101 - I did a plugins/plugins_dir split based on this Jekyll PR. I think plugins_dir is meant for local plugins used by the Armory site that aren't installed as gems. In any event, I used the default value (./_plugins) and I don't have a local _plugins directory in gh-pages, and everything works fine for me. Would you mind double checking my change? Thanks.
I think that's the problem. My config is meant for >= 3.5.0, which did redefine some stuff I changed. I don't think there's an easy way offhand to do an if/else in the config based on the version. So basically, it comes down to what baseline we want for the config. I figure it doesn't hurt to ask users to update to a relatively recent version of Jekyll. It's not like it's a critical piece of software, and the install method in the README should make updates relatively easy. (I tried getting Jekyll going using a different method on my Mac. It was...very painful.)
Yeah, I just finished updating it. It's now Jekyll 3.7.0 and it works without error.
Excellent. So you're okay with the config change now? No matter what, I should add a note in the README giving users the baseline version to use.