Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 2.56 KB

README (1).md

File metadata and controls

28 lines (16 loc) · 2.56 KB

Design environment for web hosted project updates & knowledge center

The project updates website was created for use as a tool to communicate project updates and research findings to the broader OFA team and to grantees. It is also aimed at improving the accessibility of these updates from that of the prior PDF format. The structure of the site is aimed at being simple to extend and maintain via simple HTML/CSS skills so as to allow the current design team or other non-developer team members to easily update it without requiring additional development time to be spent on non-feature work.

This directory also houses the TDP Knowledge center which deploys to https://tdp-project-updates.app.cloud.gov/knowledge-center. This contains a simplified changelog, FAQ's, and how-to resources for TDP onboarding and utilization.

How is this hosted?

It is a static website using the static file buildpack provided by cloud foundry on cloud.gov

Deployment process

Automated

When ever any PR is approved and merged into raft-tdp-main, any changes that were made to this static site will be automatically deployed to the https://tdp-project-updates.app.cloud.gov/ domain.

Review process

While the project updates site is stored in the TANF-app repo, it is not a part of the TDP application. Given that and the nature of updates involving simple HTML modifications/additions, the review process for updates to live comms should be made via the review process for design tickets rather than dev tickets involving:

  • Content review by the government product owner and tech lead
  • Accessibility review by the government accessibility reviewer

Dependencies

  • USWDS — While available via CDN, we currently store our own (slightly customized) version of USWDS locally (js and css)
  • jQuery — Jquery is a javascript library that drives all javascript functionality that USWDS's javascript doesn't have built in. This includes making other plugins like Lity function
  • Lity — Lity is an open-source accessible lightbox plugin. While it is also available via CDN we store it here)