datasf/datasf.github.io

The website for DataSF - empowering use of the City's data

datasf.github.io's Issues

Refactor publishing form to accommodate screendoor changes

Changes from v0 -> v1 break the publishing form customization. Need to refactor to adjust to the v1 embed form API.

Make domain whitelist a config option and abstract code

Data academy signups are only available to CCSF employees. To help enforce this, we validate email addresses against a domain whitelist. This is currently in datasf.js, but the domains should probably just be loaded in a yml file in the _data folder and loaded into datasf.js. Also, the code needs to be abstracted just a little bit more so we can draw on the whitelist for other forms where we want to only have input come from CCSF employees (for example, logging a publishing packet).

Buttons to view department progress do not indicate toggling

On DataSF in Progress you can view department progess which reveals a table below the progress charts. However, it is not clear that you can collapse this back (currently by clicking the button again).

Update performance target labels to indicate the right planning period

The publishing target labels "since month year" and "through month year" are hard coded. These need to be turned into variable assignments. I've done something similar for the publishing plans.

Fix the broken link in README.md

The DataSF Blogging Guide link is broken. Please fix it!

Add additional filter options

Filter by

• sequence
• upcoming??

Add documentation and improve workflows

Need to write up how the site works so others can contribute, particularly:

• Adding blog posts
• Adding resources
• Adding courses to the Academy

On a related note, need to make content creation/editing easier for others at CCSF exposing more of the elements above as a "platform" so each of the above can happen by just putting a markdown file in the right location without thinking about lots of configuration. Prose.io is a useful tool here, but it seems to have lost some steam, if I had more time, I'd like to contribute to that project. Also watching Chime closely.

Investigate and implement better automation tools

The website was simple enough when we started, but now it's time to really look at using js automation tools to support maintenance and continuous improvements over time, also looking into a more robust deployment strategy to leverage more jekyll plugins and approaches. There are 2 general approaches to this that I'm investigating:

1. Switch to hosting that allows plugins and generates on the server
2. Leverage automation and webhooks to generate the site automatically and push the _site folder to repo branch where the site is being hosted from

There are tradeoffs to consider, but both look promising as patterns to support more robust distributed editing.

Make department publishing plans printer friendly

Currently the publishing plans are not very printer friendly. It hits the good enough marker, but we want department's to be able to easily print off a clean copy for use in meetings as necessary. We'd like the printed versions to feel more like an "official" report. A couple of things we're imagining changing:

• Develop a simple, beautiful header that only shows up when printing
• Incorporate the City and County of SF seal at the top of the report, incorporate elements that link the report to the broader DataSF program
• Hide the elements "Department Publishing Plans" and the drop down in favor of this clean printable header
• Make the metrics and charts more printable (chart colors need to change, and the layout should be a little different
• Add a "page break" between the narrative and metrics, add header above metrics that only shows up printer to make the report easier to consume in printed form (read: skimmable)
• Expand the data table to show all records when printing, repeat table headers at top of each page and remove,
• Remove navigation and footer elements that are not useful in the printed form (navigation links, icons linking to github, etc.)

Why go through this when we took the pains to get it on the web? Because some of our users won't have web enabled conference rooms, and sometimes the printed report is just easier to work off of, mark up, etc. The digital future is near, but we still need to meet our users in the departments where they are.

Allow users to modify the url of a post or page

Provide an over-ride to create a short url. This is technically possible, but it is not exposed as an option on posts in CloudCannon for authors.

Images too big

Need to add some automations to create thumbnails for blog post images.

Update to kramdown and Jekyll 3.0

Per this blog post: https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0

Bad link on open data release toolkit page

On https://datasf.org/resources/open-data-release-toolkit/ the "open data publishing process" link is a broken dev link.

Some links on the open data showcase page 404

Links to Environment Apps, Transit Apps, and Crime Apps on https://datasf.org/showcase/opendata/ go to a github 404 page.

Custom text selection style is hard to read

Currently, the website has different ::selection styles depending on the browser. Perhaps using a color close to the (numerous!) defaults or the primary color + white text for all browsers is more readable. I can submit a PR with whatever's preferred if you're open to contributors :)

Current on Firefox

Current on Chrome

#B4D5FF

Primary Color + White Text

Add sort options to academy course page

Sort/group by:

• Series
• Alpha
• Upcoming??

Apply DRY to layouts/includes

Layouts and includes have gotten a little wonky leading to some duplication and inconsistent application of conventions across the code. It's not too bad yet, but would like to squash the issues now rather than later and then document the conventions in code.

Create custom 404

Nice to have a custom 404 to get users back to the site.

Test accessibility across site

Need to log all accessibility issues and shore up some of the templates and practices to reduce the introduction of accessibility issues across DataSF website

Published dataset number should pull from socrata API on the home page

Currently, I'm just manually updating which is actually quick and easy and the number updates at a regular cadence anyway, so it hasn't become overwhelming to do quickly when we finish a round of publishing. However, it should just be automatic.

I just need to repurpose some javascript from DataSF in Progress. Part of the delay on this is that I want to make sure I'm implementing this in a way that reuses a library of elements, especially as we'll want to pull certain measures and indicators into other parts of the site (beyond the in progress dashboard).