Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 3.1 KB

readme.md

File metadata and controls

62 lines (37 loc) · 3.1 KB
Raw

GitHub and Government Build Status

screenshot

Gather, curate, and feature stories of people using GitHub as part of their open government innovations.

The site is open source (here's all the code!) and is a tool for and by the community.

Submit issues and pull requests for stories, site ideas or copy edits.

Goals

  • Share stories of real world experiences using GitHub in open Government
  • Demystify open source terminology
  • Showcase the community using GitHub to promote connections and sharing between individuals and organizations.
  • Make getting started with GitHub easier

Under the Hood

This site is made with Jekyll, an open source static site generator. This means the Jekyll program takes the content we want to be on the site and turns them into HTML files ready to be hosted somewhere. Awesomely, GitHub provides free web hosting for repositories, called GitHub Pages, and that's how this site is hosted. The content for the site is on a branch named gh-pages.

Contributing

Fix/Edit Content

If you see an error or a place where content should be updated or improved, just fork this repository to your account, make the change you'd like and then submit a pull request. If you're not able to make the the change, file an issue.

Add a Story

Have an open government story to share? Instructions for contributing a story are in docs/submit.md.

Add Organization

If you know of an organization that should be added to the organization list that generates the matrix of avatars on the Community page: fork this repository, open the _data/organizations.yml file and add it to the appropriate section of the list in the format being used. Commit your change and submit a pull request to us!

To Set up Locally

You can take all the files of this site and run them just on your computer as if it were live online, only it's just on your machine.

Requirements

If you have installed GitHub for Windows or GitHub for Mac, Git was also installed automatically.

To copy the repository's files from here onto your computer and to view and serve those files locally, at your computer's command line type:

git clone https://github.com/github/government.github.com.git
cd government.github.com
script/bootstrap
script/server

Open http://localhost:4000 in your browser

Don't see what you're looking for? Create an issue, we'll do our best to help you out.