chicago/dev.cityofchicago.org

Developer resources provided by the City of Chicago and sister agencies and get technical updates from the developer blog.

dev.cityofchicago.org's Issues

Display list of GitHub projects

The site chicago.github.io lists all GitHub projects, which is based on a look-up that retrieves projects from GitHub. It would be nice to dedicate a page within dev.cityofchicago.org to that same functionality.

The page would arrange all current github.com/Chicago projects and display them. Clicking on a project would take the user to the repo.

Once completed, the chicago.github.io site can be used to simply redirect users to dev.cityofchicago.org

Footer contains all blog posts, too many

After completing #6, the footer contains blog posts from all posts, which is too much. The footer should only contain the most recent 5 posts.

Add instructions for contributing more API documentation

The dev.cityofchicago.org repo is only for the website. Other API documentation included on the website should be maintained in a separate repo. For example, the Open311 API docs are stored in a separate repository but rendered at http://dev.cityofchicago.org/docs/open311/

The README.md should be updated to provide instructions on setting this up.

Fix link on Lead Safe page

The icon at the top of the page points to lead-free, not lead-safe

http://dev.cityofchicago.org/docs/lead-safe/

Improve visibility of arrows in subrotating gallery

Need to use chunkier arrows

Make Lead Safe a featured project

After completing Chicago/lead-safe-api-docs#32 and #50, it would make sense to feature the project either in the banner image or as a featured project.

Tags links do not work in blog

Clicking on a tag in the /blog/ section only directs to "#".

Use agency / program logos in rotating gallery of APIs

Broken link in open311 rotating image

The link in this image points to http://dev.cityofchicago.org/docs/api

I believe it should point to http://dev.cityofchicago.org/docs/open311/

Post links broken on blog

Clicking on a post leads to a 404 error. The links are pointing to https://[category1]/[category2]/[post-title.html].

Need to look at the URL structure to make sure it points to https://[url]/[category1]/...

Also need to regenerate the blog posts so they appear in the folder directory. They are currently missing.

Allow image credits to be added in the hero image

Currently, images in the banner do not have a clear way to provide image credits when necessary. Would like to create a small area in either the lower left- or right-hand corner of the hero/banner image to display credits. The text can be small and just provide enough space to mention the owner of the image and mention any licensing (e.g., CC-BY).

Add further instructions on building website

Editing and adding to this website can be a bit tricky. The README should be modified to also discuss:

• Reminder to manually compile libs.js
• Working with Foundation for building the CSS

Rename/reorganize main nav for greater clarity

Need to make a few tweaks to the menu which, in combination with #22, will make it easier to find information.

• Change "docs" to "Resources"
• Add a separate entry for "Open Data Portal" in the main nav (removing exiting one under "docs"/"Resources")
  • Submenu under "Open Data Portal" should include: "Visit Portal" (data.cityofchicago.org) and "Read API docs" (dev.cityofchicago.org)

Build in Travis CI

Build Jekyll site in Travis CI. Do some testing to ensure there are no broken links. Will be following this tutorial to set that up.

Completing this will make #5 easier.

"Home" button within blog page doesn't return to main homepage

Steps to reproduce

Visiting the blog site at https://chicago.github.io/dev.cityofchicago.org/blog/index.html and click on "Home" in the upper-left hand nav bar. It fails to take you to the homepage at https://chicago.github.io/dev.cityofchicago.org/index.html and simply keeps you on the blog page.

Expected action

Should return back to the site's homepage.

Reduce the number of rotating galleries

Remove:

• Quotes
• Logos (toward bottom)

Import chicagoportalstatusblog to Dev blog

Use the jekyll-import tool to import from the Tumblr blog. The author should always be Open Data Team.

Update Health Atlas API link

The link is in the Resources tab, and the new link is https://api.chicagohealthatlas.org/api-docs/index.html

Remove Comments in blog

Move Resources links to main pages instead direct to docs

Move the links to the following URLs:

• Clearpath ▶️ http://api1.chicagopolice.org/clearpath/
• DIVVY ▶️ https://www.divvybikes.com/system-data
• Plenario ▶️ http://plenar.io

Make control paddles on main banner image more noticable

Create 404 page

• Create custom 404 page
• Update S3 configuration to use new 404 page

Several problems with paths

Consolidating #7 for a central issue on issues with links...

• Visiting the blog site at https://chicago.github.io/dev.cityofchicago.org/blog/index.html and click on "Home" in the upper-left hand nav bar. It fails to take you to the homepage at https://chicago.github.io/dev.cityofchicago.org/index.html and simply keeps you on the blog page.
• On the blog page, clicking "Older Entries" will provide a 404.
• Clicking "Read More" fails to take it to the blog post. Right now, blogs are appearing at root/category/year/month/day/title.html instead of the blog/ subdirectory.
• Clicking on blog titles in the footer leads to a 404.

Blue links are too light, hard to notice

The blue links on the main pages, such as the blog page, are too light and is hard to read. However, when hovering, it's just about the right color. So, will change the inactive link to #99D6EF and change the active link to a darker blue.

Compress banner (and other) images

Load times are running longer for some individuals which is caused by the large banner images:

• Look at compressing images more
• Use @media queries in the CSS to load smaller images on smaller devices.

Workflow to create a new blog post

@tomschenkjr - I could just e-mail you but it seemed as if whatever conversation takes place here may be useful documentation of the eventual answer. Feel free to delete this issue if you prefer to do this a different way.

I like the idea of creating a new branch for a blog post and then handling publication as a pull request. However, I am not seeing how to create a new branch in the GitHub GUI. I am not sure if I am missing it or if it is a permissions issue.

An alternative approach would be to fork the repo into my own GitHub account and do the pull request from there.

Broken link on blog when looking at newer or older entries

1. To reproduce, start at http://dev.cityofchicago.org/blog/.
2. Scroll to the bottom where pagination begins.
3. Click "<< Older Entries"

Will receive a 404 error at a URL http://dev.cityofchicago.org/blogpage2. The URL should be http://dev.cityofchicago.org/blog/page2`.

This error also happens when looking at older pages and attempting to look at newer entries.

1. Start at http://dev.cityofchicago.org/blog/page3
2. Scroll to the bottom where pagination begins.
3. Click "New Entries >>".

Will also receive a 404 error.

Just need to fix the relative URL in the _includes/pagination.html file.

Deploy Open311 docs to S3 bucket

Reminder to complete Chicago/open311-api-docs#1

Update references to travis-ci.org to travis-ci.com

The only place I see it now is in the readme

@levyj would you mind doing this with the other updates to the blog?

Experiment with "motion" gifs for header images

Static images in the hero background look nice, but interested in experimenting with subtle gifs that have some noticable movement, but nothing too dramatic.

Include Lead Safe API docs under resources

After completing Chicago/lead-safe-api-docs#32, need to modify the headers to include Lead Safe as an available resource. The link should point to the corresponding Lead Safe API docs.

Change <header> fonts to sans-serif fonts

Right now is using the serif font stack. <h*> fonts should switch to a Sans font.

Add CTA's GTFS as a resource

Separate from the already-mentioned bus and train tracker API, should also include the GTFS feed.

http://www.transitchicago.com/developers/gtfs.aspx

Broken link to Divvy

The link labeled "This API endpoint" in the below picture from about halfway down http://dev.cityofchicago.org links to http://feeds.divvybikes.com/stations/stations.json which does not work.

Improve visibility of alternative button in banner

The outlined, non-fill button is hard to see unless it's hovered over. Should use a bit of a dark translucent fill behind the text to improve visibility.

Add license and notice file

Added a LICENSE.md and NOTICE.md file. The NOTICE file needs to mention the licenses of:

• Libraries used in the template
• Images and icons used

Archives not displaying correct dates

Dates are all from 2011 and don't correspond to actual dates:

Add GitHub link to main nav bar

Link to github.com/Chicago in main nav bar

Add new GA tracking code

Prior tracking code was intermingled with http://blockee.org/, so need to create a new tracking code.

Add Google Analytics code to site

• Grab tracking ID
• Insert to code

Links to resources do not work when not starting from home page

Description

Accessing any of the links under the Resources page returns a 404 if you don't start from the homepage (dev.cityofchicago.org). It appears the relative paths are incorrect so leads to odd links.

Steps to reproduce

A working scenario

1. Visit dev.cityofchicago.org
2. Hover mouse over "Resources"
3. Select "Lead Safe"
4. Returns the correct site (http://dev.cityofchicago.org/docs/lead-safe/)

Returns a broken link

1. Visit the blog page (http://dev.cityofchicago.org/blog/)
2. Hover mouse over "Resources"
3. Select Lead Safe
4. Step 3 points you to this page which returns a 404 error

Include Terms of Use in footer

Link to http://www.cityofchicago.org/city/en/narr/foia/data_disclaimer.html

Missing files: favicon and fonts

I am seeing two errors in the console for missing files. Could be two separate issues, but they could be resolved as a single issue as well.

When I load the page a second time I don't see the favicon error, presumably because it's not checking every time.

$ jekyll serve
Configuration file: C:/Users/375492/Github/DoIT/dev.cityofchicago.org/_config.yml
            Source: C:/Users/375492/Github/DoIT/dev.cityofchicago.org
       Destination: C:/Users/375492/Github/DoIT/dev.cityofchicago.org/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
                    done in 16.82 seconds.
 Auto-regeneration: enabled for 'C:/path/to/project/dev.cityofchicago.org'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.
[2018-12-28 11:46:37] ERROR `/fonts/font-awesome/fontawesome-webfont.ttf' not found.
[2018-12-28 11:46:38] ERROR `/favicon.ico' not found.

Setup deployment to S3

Likely via Travis CI. Deploy to S3 automatically.

Use :after elements for header seal

Currently, the logo and text is completely an image that does not scale well. Objective is to use a city seal image but use the :after pseudo-element to render text in the browser.

Auto-rotating image gallery is broken

The rotating set of images are not auto-advancing. The user can click arrows to advanced images, but otherwise does not advance after the site is loaded.