Components for creating a team Hub using Jekyll
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is even with 18F:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.gitignore
CONTRIBUTING.md
COPYING.txt
Gemfile
LICENSE.md
README.md
Rakefile
team_hub.gemspec

README.md

team_hub Gem

Gem Version Build Status Code Climate Test Coverage

Contains reusable components extracted from the 18F Hub implementation for creating a team Hub using Jekyll. See the 18F Public Hub for a running example.

Downloads and API docs are available on the team_hub RubyGems page. API documentation is written using YARD markup.

Contributed by the 18F team, part of the United States General Services Administration: https://18f.gsa.gov/

Motivation

The 18F Hub repository aims to provide a lightweight, easily-adaptable template for websites like the 18F Public Hub, to empower Instigators across the US federal government and beyond to spread modern software development practices. Consequently, 18F will be extracting more and more generic, reusable components into this gem, leaving the plugins in the 18F Hub repository very lean and declarative, so that others may more easily understand how to adapt the Hub template to their own team's needs.

Installation

Add this line to your application's Gemfile:

gem 'team_hub'

And then execute:

$ bundle

Or install it yourself as:

$ gem install team_hub

Usage

More documentation will be forthcoming as this gem is built up with features extracted from the 18F Hub. For now, see the 18F Hub Plugins directory to see how parts of team_hub are currently used, and to see hints of functionality that will be added to team_hub in the near future.

Contributing

  1. Fork it ( https://github.com/18F/team_hub/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Feel free to ping @mbland with any questions you may have, especially if the current documentation should've addressed your needs, but didn't.

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.