Skip to content
This repository has been archived by the owner. It is now read-only.
A handbook for those wishing to recruit a self-organizing volunteer group to address organizational needs
Ruby HTML CSS
Branch: 18f-pages
Clone or download
mbland Merge pull request #23 from 18F/update-working-groups-data
Update reference to Working Group data
Latest commit 651d2e1 Feb 19, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets/css Convert to use the `guides_style_18f` gem Aug 31, 2015
images Convert to use the `guides_style_18f` gem Aug 31, 2015
pages Update reference to Working Group data Feb 19, 2016
.gitignore Update gems, including guides_style_18f and Jekyll Nov 13, 2015
CONTRIBUTING.md Initial commit Feb 1, 2015
Gemfile
Gemfile.lock Update gems, including guides_style_18f and Jekyll Nov 13, 2015
LICENSE.md Initial commit Feb 1, 2015
README.md Update README Apr 27, 2015
_config.yml
go
index.html Merge pull request #16 from 18F/guides-style-18f Aug 19, 2015

README.md

Grouplet Playbook

"Grouplets" are self-organizing teams of volunteers that address concerns affecting a broad segment of the organization. 18F currently has two types of Grouplets.

This website is based upon the 18F Guides Template.

Generating the site/hosting locally

You will need Ruby ( > version 2.1.5 ). You may consider 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.

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

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

$ git clone git@github.com:18F/grouplet-playbook.git MY-NEW-GUIDE
$ cd MY-NEW-GUIDE
$ ./go init
$ ./go serve

This 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/guide/. (Make sure to include the /! The built-in Jekyll webserver doesn't redirect to it.) That page contains further instructions on how to adapt the template to a new guide repository.

After going through these steps, run ./go to see a list of available commands. The serve command is the most common for routine development.

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.