Dashboard

A site to track our projects' status and much, much more...

Goal: Provide transparency and insight into 18F work and values.

Audience: 18F team, GSA, other government agencies, transparency community, journalists, prospective 18Fers

Dashboard Content

The data points for this project are listed as GitHub issues. Milestone 1 issues are the most basic info that we intend to display in the initial list view of the dashboard. When users click on a project in that list, they will see the the data points listed under Milestones 2 and 3 on individual project pages. The Backlog Milestone includes data points that need further research or are currently not a priority.

Data was prioritized based on our initial interviews, research, and guesses about how many of the audiences listed above would be interested in a data point, and then balanced against level of effort required to obtain or incorporate a data point.

Is there data that you'd like to see about our projects that's not listed here? Create an issue! We value feedback.

Installing

First clone this repo. Then, install the project and all its dependencies by running ./go init in your terminal. After that, run ./go serve and visit http://localhost:4000 in your web browser.

For 18F Team Members

If you're a developer and want to experiment with the data you can do so by running git submodule init and git submodule update --remote. This will fetch the latest yaml files out of the data-private repo, the same one driving data for other 18F projects like the Hub.

For everyone else

By default you get all of our projects, and the information about them should refresh itself whenever you run git pull. Which is pretty cool, we think.

If you're looking to make your own dashboard using this as an example, you can. Each project is defined in the _data/projects.yml file. Fill in all the fields for your project and then create an html file in pages/projects and give it a name matching the name field in the YAML file.

Structure of a project

Each project is represented in YAML as a set of fields, some are required, some optional, and some require a specific kind of formatting. Here is an example of a project in our dashboard.

- project: myRA
  name: myra
  github:
  - 18F/myra
  description: "Landing page design for Treasury’s My Retirement Account program, which will provide a simple, safe, and affordable way for individuals to start saving for retirement."
  partner:
  - "U.S. Department of Treasury"
  impact: "Millions of Americans do not have access to an employee-sponsored retirement plan: more than 50% of full-time and 75% of part-time workers."
  stage: alpha
  milestones:
  - "August 2014: Project discovery stage started"
  - "September 2014: Project moved from discovery to alpha"
  contact:
  - [email protected]
  stack: "JavaScript, Jekyll"
  team: chrisc, manger
  licenses:
    myra: Public Domain (CC0)
  links: http://myra.treasury.gov
  status:

Fields

• project The non-slugified name of the project
• name The project's handle (slugified version of project)
• github The organization and repo name for the project's code (e.g., 18F/myra)
• description A brief description of the work involved in this project
• partner A dashed list of the partners (or clients) this project serves
• impact A brief description of the project's outcomes
• stage Alpha? Beta? Discovery? See https://18f.gsa.gov/dashboard/stages for more definitions of these stages
• milestones Free format dashed list of important accomplishments during the project
• contact An email address or GitHub-relative URI for the project (e.g., 18F/myra/issues)
• stack What tech are you using here?
• team Who is on the project? Requires an api endpoint configured on your main site
• licenses A list of key-value pairs where the key is the github repo and the value is the license (e.g., myra: Public Domain (CC0))
• links A relevant links you wnat to include (despite the name we currently only support one here)
• status For now, set this to hidden to hide the project from the dashboard (you might want to do this if you have incomplete data, for example)

Except for project and github none of these will cause your dashboard to fail if they're missing but the project's page will look a bit thin.

JavaScript

There are three variables at the beginning of the assets/js/main.js file that you'll want to set in order to grab data about your projects.

var GITHUB_API = "https://api.github.com/";
var GOVCODE_API = "https://api.govcode.org/"
var ORGANIZATION = "18f";

You can probably leave most of these as they are, but the ORGANIZATION variable you'll want to set to whatever org your repos are under. Right now we only support pulling data from one organization's repos.

The JavaScript also assumes there's a json file accessible somewhere on your server that is an index of your team. You'll want to set the TEAM variable to wherever that might be.

var TEAM = urlRoot+"/api/data/team.json"

With the code above we are assuming that json file is on the same server as the Dashboard, but you should modify that section of code if that's not the case for your server.

HTML

Once you have the YAML in place, create an html file in the pages/project directory that shares its name with the name field. For example, pages/project/myra.html.

Then you need to include a small bit of YAML frontmatter for that project.

---
layout: project
title: "api.data.gov"
permalink: /project/api-data-gov/
---

In the above YAML the title field should match the project field in projects.yml and the permalink can be anything you like.

Caveats

For now this dashboard will attempt to find project data from your organization on GovCode. If you're not on GovCode, you'll have to try and get that data from another source. A future version will likely handle these data in a more robust way.

This site will also generate a publicly accessible json file at api/data/projects.json if it is run on a non-GitHub pages server. Because GitHub Pages runs Jekyll in safe mode, it will not generate on GitHub pages. If you want to make that data accessible on GitHub pages, you could consider converting projects.yml to a JSON file and following the directions on this IRC transcript..

Feedback

Give us your feedback! We'd love to hear it. Open an issue and tell us what you think.