Getting Started

1. Clone the repo to your projects directory (mkdir -p ~/projects && git clone [email protected]:clirdlf/ndsa.org.git). If you have a new computer, you may need to set up your keys.
2. Make sure you're on the gh-pages branch (cd ~/projects/ndsa.org && git checkout gh-pages).
3. Install the dependencies (bundle install).

#! /usr/bin/env bash

mkdir -p ~/projects && git clone [email protected]:clirdlf/ndsa.org.git
cd ~/projects/ndsa.org && git checkout gh-pages && bundle install

Local Development

• Use Atom
• Use the Jekyll-Atom plugin
• Start the server (Packages -> Jekyll -> Open Toolbar) and click Start/Stop Server
• Open your browser to http://localhost:3000

Every time you save a change, Jekyll will rebuild the website.

Content Edits

Interest Group and Working Group co-chairs as well as Coordinating Committee members are welcome to make content edits to ndsa.org. Please create a GitHub account and e-mail [email protected] to get added to the NDSA GitHub repository.

Content edits can be easily made on the browser-based GitHub editor.

• Find the relevant page (for example, the page for the Standards and Practices Interest Group is standards-and-practices.md)
• Click the pencil icon or type "e" to edit the file
• Make the edits, add a short description, and commit the changes to the gh-pages branch

For information on formatting, please review the Markdown Cheatsheet. GitHub keyboard shortcuts can be found here.

Blog Posts

Blog posts are written and served from https://www.diglib.org/. There is a rake task to import these and convert them to the Jekyll format.

$ rake import:rss

This will load the full content of the posts from the RSS feed and generate the appropriate files. Any changes (typos, links, etc.) need to be made at https://www.diglib.org.

Membership Data

There are Rake tasks that will retrieve data from the Google Spreadsheet where the application data is saved. By default, you only need to run rake in the project directory.

$ rake

This will generate new files needed by the members-list page.

rake
git commit -am "Added [organization] to the members-list page"

The applicant's active field needs to be set to TRUE (ALL CAPS) or these scripts will skip over the processing.

Validating HTML

This app uses html-proofer to validate HTML (especially links and whatever). All of the dependencies are installed via bundler and executed via rake task:

$ rake test:html

Accessibility

We're using pa11y for accessibility testing.

Installation

You will need to make sure you have npm installed. Easiest way on OS X is with brew.

$ brew install npm
$ npm install -g phantomjs pa11y
$ gem install

Generating a Report

There is a Rake task that will generate the appropriate report:

$ rake test:accessibility