Skip to content
This repository has been archived by the owner. It is now read-only.
A guide for the Agile Delivery Services BPA
Ruby HTML Shell CSS
Branch: 18f-pages
Clone or download
Latest commit e92fd50 Jul 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Migrate to CircleCI (#70) Sep 21, 2017
_includes more order formatting Feb 1, 2018
_pages Copy changes Feb 13, 2018
assets/css more order page tweaks Feb 1, 2018
data Removed FS order #4 Jul 16, 2018
images major revamp take 1 Jan 31, 2018
.gitignore Initial commit May 30, 2015
.jekyll-metadata more order formatting Feb 1, 2018
.ruby-version major revamp take 1 Jan 31, 2018
CONTRIBUTING.md major revamp take 1 Jan 31, 2018
Gemfile major revamp take 1 Jan 31, 2018
Gemfile.lock major revamp take 1 Jan 31, 2018
LICENSE.md Initial commit May 30, 2015
README.md major revamp take 1 Jan 31, 2018
_config.yml more order page tweaks Feb 1, 2018
go
test.sh add back in test.sh to eval yaml Feb 14, 2018

README.md

Agile BPA micro-site

This is a skeleton repo containing the CFPB/DOCter-based Jekyll template for 18F Guides.

Getting started

Installing Ruby

You will need Ruby ( > version 2.2.4 ). To check whether it's already installed on a UNIX-like system, open up a terminal window (e.g. Terminal on OS X) and type ruby -v at the command prompt. For example, you should see something similar to the following:

$ ruby -v
ruby 2.2.4p230 (2015-12-16 revision 53155) [x86_64-darwin15]

If the version number is less than 2.2.4, or instead you see something like:

$ ruby -v
-bash: ruby: command not found

Then Ruby is not installed, and you should choose one of the installation methods below. The "Installing Ruby" page of the official Ruby language web site explains how to do this in a number of ways across many different systems.

Quickest Ruby install/upgrade for OS X

On OS X, you can use Homebrew to install Ruby in /usr/local/bin, which may require you to update your $PATH environment variable:

$ brew update
$ brew install ruby
Optional: using a version manager

Whether or not Ruby is already installed, we strongly recommend using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.

Cloning and serving the Guides Template locally

To create a new guide and serve it locally, where MY-NEW-GUIDE is the name of your new repository:

$ git clone https://github.com/18F/guides-template.git MY-NEW-GUIDE
$ cd MY-NEW-GUIDE
$ ./go serve

The ./go script will check that your Ruby version is supported, install the Bundler gem if it is not yet installed, install all the gems needed by the template, and launch a running instance on http://localhost:4000/.

Follow the template instructions

The Guides Template (either running locally or the published version) will walk you through the rest of the steps to edit and publish your guide.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

You can’t perform that action at this time.