timwis / jkan

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

Enable open authoring and editorial workflow #271

Open timwis opened 1 year ago

timwis commented 1 year ago

Per #210, this pull request enables open authoring, a beta feature that ships with Decap CMS (formerly Netlify CMS). It allows guests of the site to propose changes to its content via GitHub pull request, which I reckon would be quite a hit for an open data portal (especially if we add an "Add Dataset" button).

Here's what it looks like for a guest to propose an edit to a dataset (note they already have a GitHub account in this video, which presumably won't be the case for most guests):

https://user-images.githubusercontent.com/761444/231369068-3488dac6-ace8-48c3-8fc8-daa3f615c797.mov

At the end of this video, Decap CMS created a pull request on the site's repo. And, because it's hosted on Netlify with deploy previews, it also generated a preview site for the pull request.

The open authoring feature requires we enable another feature called "editorial workflow." In editorial workflow, changes (by normal admin users) are also proposed via pull request, in theory so that an editor can 'review' them. Decap CMS provides a kanban-style view for reviewing pull requests:

Screenshot 2023-04-12 at 07 31 37

This is a nice feature if there are multiple people working on the site, though I imagine it's designed for reviewing prose (e.g. blog posts) rather than metadata, and the downside is that it takes several extra clicks and is less counter-intuitive to make a small change. Here's what the process looks like for an admin updating their own dataset:

https://user-images.githubusercontent.com/761444/231371026-6f87115d-4938-4b01-bc6a-f17509d8b0bd.mov

I'm leaving this as a draft pull request because I'd like feedback on whether we should enable this feature by default (well, technically both features), or have it be opt-in and document it? Perhaps we could trial it on OpenDataPhilly @BryanQuigley?

BryanQuigley commented 1 year ago

That looks awesome!

At the time being https://opendataphilly.org/ launched late last week with JKAN via GitHub Pages. (I also just left E84/Azavea, but still plan to be involved). We opted to get the launch done just to drop the Netlify Edit buttons.

I don't see any reason not to enable it for those that go the Netlify route (which I expect to be whoever does it next..).