search

timwis / jkan

A lightweight, backend-free open data portal, powered by Jekyll
https://jkan.io
MIT License
219 stars 309 forks source link

Remove "theme" key from _config #127

Closed patcon closed 7 years ago

patcon commented 7 years ago

Not sure if there was a change in GitHub Pages, but this seems to cause issues now: https://github.com/timwis/jkan/blob/gh-pages/_config.yml#L8

I removed the key completely and it works fine. Might have also been the titlecasing :)

timwis commented 7 years ago

Interesting -- what was the issue it was causing? That setting is used to change the JKAN theme (bootswatch).

patcon commented 7 years ago

In the repo settings page where GH pages build status shows up, it said there was a problem building, and that that theme was unknown

timwis commented 7 years ago

Gah! https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/

timwis commented 7 years ago

Looks like it'd be pretty easy to use a different variable, like jkan_theme, but I'm concerned about the fact that it essentially broke editing functionality on every JKAN instance... I just tweeted github about it

timwis commented 7 years ago

So GitHub replied suggesting that this will be resolved in Jekyll 3.3 per jekyll/jekyll#5189. Unless I'm misreading that thread, it doesn't look like it will resolve this issue.

I think the only thing we can do is change the property for now, and hopefully any existing JKAN users will upgrade. Unless you can think of another idea? I suppose we could submit pull requests to all forks...

timwis commented 7 years ago

This is resolved in v1.0.3 so closing the thread. But please respond if you have any other ideas on how we can notify users to upgrade, or make it work for them?

timwis commented 7 years ago

Just heard back from Nick at GitHub:

I just wanted to follow up and let you know that the team pushed out an update to GitHub Pages early this morning. You should now receive a warning instead of a hard fail when using the theme: parameter.

Thanks for your patience, and for reporting this to us. Please let us know if there's anything else we can do for you!

So this should unbreak any existing JKAN forks. Woohoo!