The biggest difference you'll see in Version 2.0 is that we've replaced the built-in editing UI with Decap CMS (formerly known as Netlify CMS), a drop-in content management system for static sites. Doing so has allowed us to trim the JKAN codebase quite considerably (we've removed the vast majority of the JavaScript). As always, using the editor is optional. You can read about the options for using it in docs/installation.md. Big thanks to the great contributions from our pals at Azavea/Element 84, @BryanQuigley, @lukemckinstry, and @lydiascarf! And to @dracos for a contribution from several years ago that we've finally merged!
Breaking changes
- Upgraded ruby version to
3.1.2
, and upgrade ruby and JavaScript dependencies to recent versions - Replaced built-in editing UI with Decap CMS (formerly known as Netlify CMS)
- Restructured
licenses.yml
for compatibility with Decap CMS. As a result,site.data.licenses
is nowsite.data.licenses.items
. - Split categories.yml into collection (directory of files). As a result,
site.data.categories
is nowsite.dataset_categories
. - Added out-of-the-box config for hosting on Netlify
- Added GitHub Actions workflow for publishing to GitHub Pages
- Removed default
baseurl
setting from_config.yml
- Switched to parcel for JavaScript bundling instead of Webpack
- Upgraded to Bootstrap v5, which means bootswatch themes no longer work
Non-breaking changes
- Added support for uploading category and organization images
- Ensured the site works without JavaScript
- Added a
/categories/
index page and a page per category - Added a homepage hero image
Deprecations
- We now recommend hosting JKAN on Netlify, but still support GitHub Pages and other static hosting providers.
- If you use GitHub Pages, you'll need to switch on GitHub Actions in your repository to replace the legacy publishing workflow.