search

18F / pclob

The Privacy and Civil Liberties Oversight Board (PCLOB) website.
https://www.pclob.gov
MIT License
1 stars 2 forks source link

readme

CircleCI

Privacy and Civil Liberties Oversight Board website

This is a Jekyll project for the new Privacy and Civil Liberties Oversight Board (PCLOB) website.

This site is made for use with the Federalist in mind.

Running the site with Docker

If you don't want to have to deal with making sure that you have the proper versions of dependencies installed, you can use Docker instead. It takes care of all the dependencies for you, and provides an environment similar to the one which Federalist builds your site on.

  1. Install Docker Community Edition.
  2. Clone the repository.
  3. Run docker-compose up.
  4. Visit the local site at http://localhost:4000/dev/

If you ever decide that you no longer want to use Docker, run docker-compose down -v to properly clean everything up.

For extra configuration options, copy .env.sample to .env and edit it as needed.

Running the link checker

To make sure the site doesn't have any 404s or other consistency issues, run:

npm install
npm test

Editing page content

If you're ever on a page and want to make a change to its content, add #devmode to the end of the URL. You'll then see an "Edit this page" link at the bottom-right of the page; clicking on this will take you to a GitHub edit page where you can make changes.

Upgrading USWDS

This project uses the CSS and JavaScript from U.S. Web Design System.

To update the version of the system, download the code from the website. Unzip the download and drop the entire folder (which should be named something like uswds-1.3.0) into assets/vendor.

In your _config.yml, update the wds-version value to the new version number. This should match the version number in the name of the folder you just downloaded. In the case of our example, it would look like this: wds-version: 1.3.0. You'll need to restart your Jekyll server to see the new code take effect.

18F Open Source Policy

This repository contains the official Open Source Policy of 18F (a digital delivery team within the General Services Administration).

Read 18F's Open Source Policy.

18F Team Guidance

For 18F team members, we have guidance on how 18F puts this policy into practice, and how we handle the narrow situations where we may delay or withhold the release of source code.

18F's open source team practices.

Credits

This policy was originally forked from the Consumer Financial Protection Bureau's policy. Thanks also to @benbalter for his insights regarding CFPB's initial policy.

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.