Git Product home page Git Product logo

brennancenter.github.io's Introduction

judicialselectionmap.brennancenter.org

This is the website that hosts the Judicial Selection Map of the U.S. The files here all play a role in building the final site. The site is hosted on GitHub, and by default is at brennancenter.github.io

Updates

The importance of Commit Messages. Throughout this document, you will see mention of commit messages. This web application will likely be maintained/updated by different people at different times. And sometimes, you might make a change at one point, and then go back a few months later only to try and remember what you were thinking at the time you'd made that change. A commit message is a favor to your future self, and any other people in the future, who are trying to understand what the status of the visualization is.

A commit message is just like an email message: a short subject to summarize the changes you've made, and a longer message (if necessary only) to put any important details. It's like "the ship's log" in a way -- it maps the journey of this visualization.

Also: the Github interface only enables the "Commit changes" button when you have typed in a commit message subject.

Data

Main data

The main data is controlled in a Google Spreadsheet. This spreadsheet serves as the master file of record. Whenever any changes are made to the spreadsheet, they are not immediately reflected in this visualization. To do that:

  1. Load the Google spreadsheet
  2. Select the "Vertical Data" tab.
  3. Make changes to the dataset here. Important: Please don't change any of the headers (rows 1-5).
  4. Download the tab as a CSV file to your computer
    • On the spreadsheet, click the "File" menu
    • Scroll down to "Download as"
    • In the new list, scroll to "Comma-separated values (.csv, current sheet)"
    • Confirm to "save" in the next dialog box
  5. Using your File Explorer application (e.g. Finder (Mac) or Windows Explorer):
    • Find the Download folder (or wherever your csv file is downloaded)
    • Rename the csv file:
      • From: "Judicial Selection Dataset (Vertical Data).csv"
      • To "brennan.csv"
  6. In your web browser, go to the data/ subdirectory in this repository
  7. Click the "Upload Files" button and upload your brennan.csv file
  8. Make a comment and commit * In your comment, please try and summarize the changes that were made to the dataset.

Tooltips/Descriptions

  1. On the same Google spreadsheet as above, select the "Tooltips" tab
    1. Make necessary changes
    2. Select "File"
    3. Select "Download as.."
    4. Select "Comma-separated values (.csv, current sheet)"
    5. Confirm the file should be saved.
  2. Using Windows Explorer or Finder, as appropriate, go to the Downloads folder (or wherever the csv was saved)
  3. Rename the csv file
    • From: "Judicial Selection Dataset (Tooltips).csv"
    • To: "reference.csv"
  4. In your web browser, go to the data/ subdirectory in this repository
  5. Click the "Upload Files" button and upload your reference.csv file
  6. Make a comment and commit
    • In your commit message, please summarize the changes that were made to the dataset

Colors

The various colors in use on the site are configurable in one css stylesheet file. Click the pencil icon, which will then let you edit the file. When you are ready to commit, please put a brief description/reason for your change, and then click "Commit"

Introduction Text

The introduction text is currently divided into three columns on a desktop view. Each column is contained in a separate file. So, simply go into the _introduction directory and edit the file which corresponds to the column that you want to change. It should adjust to give you the same number of columns as the number of files in the directory, so delete a file for two columns, etc. Note: "{:target=_blank}" opens the link in a new tab.

To edit the file, click on its name, then click on the pencil icon. Please make sure to put a brief description/reason for your change when you commit the change. Use markdown to format the text. Markdown is easy to learn and easy to read by both humans and computers.

Site title, description, logo image, etc

These are all configured in the _config.yml file

Google Analytics

Ensure you have an account to track this site. From there, you can paste the cookie ID (beginning with "UA-") into the _config.yml file as well.

Behavior/Transitions, New Visualizations

The main functionality of the visualization is written in javascript, using the d3.js library. Thus, modification of code will require the services of someone familiar with javscript, and comfortable with d3.js. More instructions in the wiki.

brennancenter.github.io's People

Contributors

aasarava avatar brennancenterforjustice avatar dependabot[bot] avatar justincharles avatar seemantk avatar

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.