Giter Club home page Giter Club logo

opendataphilly-jkan's Introduction

JKAN

A lightweight, backend-free open data portal, powered by Jekyll

Open-source data portals can be really hard to install and maintain. But their basic purpose of providing links to download data really isn't that complicated. JKAN is a proof-of-concept that allows a small, resource-strapped government agency to stand-up an open data portal by simply clicking the fork button.

Demo site

Documentation

opendataphilly-jkan's People

Contributors

amercader avatar bryanquigley avatar dracos avatar jjediny avatar keeganmcbride avatar kistine avatar lukemckinstry avatar lxyu0405 avatar lydiascarf avatar pezholio avatar timwis avatar tobinbradley avatar tursics avatar wilsaj avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

opendataphilly-jkan's Issues

bootstrap 5 upgrade upstream

Forked from #6

Tim already has a WIP for this, but we should see how we can accelerate this as many of our other changes get more complicated if we don't do this first.

Usability/design check for upstream JKAN

If possible, let's do a quick pass to see what can be improved from a user perspective. Time box and make new issues if bigger tasks.

The goal would be to contribute to upstream, but to show lots of datasets this repo may be more useful sooner.

The upstream repo is currently at: https://github.com/timwis/jkan/tree/v2.

Notes:

  • part of the goal was to have most functionality work without javascript.
  • we are not planning to use the editing bit (was Netlify CMS) for OpenDataPhilly

hope to have a better test site up with data soon, but for now the most up-to-date site is https://bryanquigley.github.io/jkan/

But basically the current https://www.opendataphilly.org/ looks better. Some functionality we are just going to lose moving from CKAN to JKAN (doing for less maintenance/cost going forward)

The goal of this ticket is to identify usability or other design improvements that don't require adding functionality.

Add Contact and Terms pages

We no longer have a footer (there's a file, but I think it's empty), which has removed the Contact page (which included the Google Group and the [email protected] info) and the Terms page, which included disclaimers on liability.

Search functionality should have more visibility into datasets

This is report from @Kistine about trouble finding data sets:

as I went to search for a dataset I know is listed under a data entry, no results showed. Is there any way to improve the search feature so that it will display dataset entries based on details within the entry, not just the title of the entry itself?

LNI has been updating a dataset (currently called 'subcontractors') and it's to be replaced with the updated dataset called 'Permit contractors.' When I search on the ODP page for 'subcontractors,' it displays 0 results. In this case, I know that the subcontractors dataset is filed under the LNI permits dataset. This will significantly affect end-users being able to find relevant data. On the editing end, I usually search before I add a dataset just to make sure it doesn't already exist somewhere to avoid duplicative entries.

Create a plan to enable us to track upstream easily

We want to be able to track upstream easily and have other contributors to ODP here. What needs to be considered to make it so we have very little chance of merge conflicts between us and upstream.

Should also include branch names etc. Maybe we should have our changes in a separate branch?

Homepage, Suggested feature: search box

Likely worth waiting for #10, contribute upstream

Suggested feature: Add a search box to the homepage to match old OpenDataPhilly site. On submit, forward to Datasets page and populate search there.

Missing L&I Permits Building and Zoning Permits dataset?

I'm concerned we're missing a dataset, and wonder if it's due to a recent pull request. However, it's also possible that the constricted search just means I'm having trouble finding it. I'm looking for L&I's Building and Zoning Permits dataset - it used to be filed under https://www.opendataphilly.org/dataset/licenses-and-inspections-building-permits

We recently updated it to include 'permit contractors' to help it show up in searches. When I searched 'building,' 'permits,' and 'zoning' or 'contractors,' I'm not finding it. Let me know if I'm just overlooking it in the search results.

Launch!

Once the homepage/datasets are in a good enough place - we should make the JKAN version the default.

Fix and document spin up steps

Currently docker compose is not working, possibly because of a broken upstream jekyll docker image.

These steps should assume running on host with Jekyll.

HTML tags in dataset entries are rendered as text

There are HTML tags (and possibly some markdown) in dataset descriptions. These are being display as HTML, rather than interpreted.

I don't know if we should treat this as a bug or find a way to strip out all of the tags and replace them with line breaks. Some examples in search results and on a data set page below:

image

image

Bring up test site off of this repo

Start by creating next.opendataphilly.org as the Github pages host.

This will be the "staging" site, and we should for the time being build off of merge requests to.

Homepage: UX/UI Improve category list card component and other tweaks

Ideally this should be an upstream improvement that we get feedback on. Some feedback already in timwis/jkan#253

Needs #10 first

  1. UX: Rename “Start browsing” to “Browse all datasets”
  2. UI: Improve Category list:
  • Use a card component
  • clarify hover state (highlight card/icon, not just text underline)
  • Left align cards if they don't fill the entire row (use CSS Grid)

Implement capability to harvest data from DVRPC and import to OpenDataPhilly

DVRPC has recently deployed a new CKAN instance hosting metadata on 157 data sets. OpenDataPhilly previously hosted several DVPRC data set entries but they were not maintained, and they asked us to remove them a few years ago. We now only host entries for 4 applications.

DVRPC would like to maximize exposure of their data and is supportive of the idea of having their dataset entries hosted on OpenDataPhilly, but they don't want to maintain two sources of truth.

The suggested approach would be to have DVRPC either publish a data.json that ODP harvests, converts to markdown, and adds to the datasets files or have them generate MD files that ODP harvests from a known location. There may be other solutions as well, but these were the initial two that we discussed. This harvesting would be done daily or weekly, perhaps through a GitHub action.

Revise home page design

Also doesn't need to mention JKAN on homepage.

The icons might be easy to fix, I think it's just a sizing and color thing - they would look better if they were sized more proportionally to other page elements and had a color matching the theme.

Disable NetlifyCMS Links

Disable edit button on:
_layouts/category.html: <a href="{{ "/editor" | relative_url }}/#/collections/categories/entries/{{ page.slug }}" class="float-end btn btn-outline-secondary admin-only">Edit
_layouts/dataset.html: <a href="{{ "/editor" | relative_url }}/#/collections/datasets/entries/{{ page.slug }}" class="pull-right btn btn-outline-secondary" data-hook="edit-dataset-btn">Edit
_layouts/organization.html: <a href="{{ "/editor" | relative_url }}/#/collections/organizations/entries/{{ page.slug }}" class="float-end btn btn-outline-secondary">Edit

We aren't deploying to Netlify so let's turn them off.

I think this can just be done in ODP, but if it's easy to make conditional on building on Netlify or something we could do that upstream

Review and revise all SEPTA entries

There are 14 catalog entries for SEPTA but many of the resources have been moved. In addition, SEPTA has released new data sets that are not listed. We need to take several actions:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.