Front-end for the National FOIA Portal
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3e925c1 Oct 17, 2018
Permalink
Failed to load latest commit information.
.circleci Remove cloud.gov deploy Nov 17, 2017
.github
bin
docs Update Tips.md Apr 25, 2018
js DOJ-609: Temporarily hide Agencies by Category. Revert this to get th… Aug 17, 2018
samples API spec feedback (#106) Sep 7, 2017
www.foia.gov Update footer.html Oct 17, 2018
.eslintrc Add upload progress indicator Nov 7, 2017
.gitignore Add a vagrant file for debugging foia-proxy Oct 31, 2017
.htmlprooferignore
.ruby-version Jekyll-ize the repo (#52) Aug 17, 2017
CONTRIBUTING.md Add contributing docs (#10) Jul 31, 2017
Gemfile Jekyll-ize the repo (#52) Aug 17, 2017
Gemfile.lock Jekyll-ize the repo (#52) Aug 17, 2017
LICENSE.md remove SIL language Dec 4, 2017
Makefile Place exitscript js on build Feb 14, 2018
README.md Updated CircleCI svg path Jan 23, 2018
Vagrantfile Add a vagrant file for debugging foia-proxy Oct 31, 2017
_config.development.yml
_config.production.yml Add app_env config to jekyll Nov 9, 2017
_config.staging.yml Add app_env config to jekyll Nov 9, 2017
_config.yml Add in FOIA statute to the nav menu Oct 16, 2018
agency-api-spec.md Update dev api settings Nov 8, 2017
manifest.yml Reduce memory size for development (#84) Aug 30, 2017
migrate-legacy.js Jekyllize legacy pages (#252) Oct 26, 2017
package-lock.json DOJ-610: Remove the datatables package. Apr 13, 2018
package.json DOJ-610: Remove the datatables package. Apr 13, 2018
team-practices.md Update team-practices based on new kanban cols Oct 30, 2017
vagrant.sh Add a vagrant file for debugging foia-proxy Oct 31, 2017
webpack.config.js DOJ-610: Linting fixes and docs. Apr 14, 2018
webpack.config.test.js

README.md

CircleCI

foia

New FOIA beta site + national portal. The site is based off of 18F recommendations from our discovery sprint with the Department of Justice.

Content

Majority of the site content is in markdown format. Markdown is intended to be as easy-to-read and easy-to-write as is feasible. Here are some resources for working with markdown.

The entire site can be edited directly from this Github repository. Here are some resources for working with Github.

Workflow

This Github repository is setup with continuous deployment. That means that any change you make, approve, and merge will be automatically deployed. This means you can easily see the changes you make in the development environment and once approved, deploy to production automatically. The process in general works like this:

  1. Edit a file on Github.
  2. Commit the change to the develop branch.
  3. Any change made to develop will be automatically deployed to the development environment.
  4. Review the change on the development environment.
  5. Open a pull request against the master branch.
  6. Have a teammate review and approve the code change in Github.
  7. Merge the pull request.
  8. The change will be automatically deployed to the production environment.

For the nitty-gritty details of how automated deployment works, please see the deployment documentation.

Web content

Site content lives in the markdown pages under the www.foia.gov directory.

Glossary terms should be edited in markdown, one term per file. The name of the file is not important. The term is pulled from the front matter within the file.

The primary and secondary navigation items live in the site configuration file.

The landing page content lives in configuration and in the layout.

Footer links can be edited in the site footer.

FOIA request forms

Individual agency FOIA request forms live in the back stage and are owned by OIP. However, the per-section help text (blue box content) can be edited one section per-file in markdown. The files should be numbered so they appear in the correct order, but the name of the file is not important.

Note: You should avoid changing the front matter in these files. The front stage javascript application depends on this information.

Agency contact information

Contact information lives in the back stage but this information should be updated individually by agency FOIA personnel.

Development

Please browse the additional documentation topics on development.