HHS / simpler-grants-gov

https://simpler.grants.gov
Other
44 stars 13 forks source link

[Task]: Clean up `infra` ADRs #2095

Open acouch opened 1 month ago

acouch commented 1 month ago

Migrated from https://github.com/navapbc/simpler-grants-gov/issues/187 Originally created by @acouch on Fri, 06 Sep 2024 14:06:04 GMT


Summary

When the project was setup, a number of adrs were brought from the template and left in a separate folder: adr. Two of them are duplicates. The rest are relevant to the project but where not made on the project and inherited from Nava's infra template.

This ticket is to clean that up. Every project is built off of an innumerable pile of existing decisions and one could argue that the template decisions should not be included here, or that the template is a special case. We could remove the, pull them into the current format, or take another action. Options:

  1. Remove the duplicates and move the remaining infra ADRs into the correct format and folder
  2. Remove all of the infra ADRs
  3. "2." but add an ADR for adopting the infra template which links to the infra template decisions

Infra folder ADRs

doc duplicate
ADR-0000 - Use Markdown Architectural Decision Records Recording Architecture Decisions
ADR-0001 - CI/CD Interface Task Runner for the CI / CD Pipeline
ADR-0002 - Use custom implementation of GitHub OIDC to authenticate GitHub actions
ADR-0003 - Manage ECR in prod account module
ADR-0004 - Separate tfbackend configs into separate files
ADR-0005 - Database module design
ADR-0006 - Provision database users with serverless function ADR-0007 - Database Migration Infrastructure and Deployment

Acceptance criteria

acouch commented 1 month ago

Migrated from https://github.com/navapbc/simpler-grants-gov/issues/187#issuecomment-2340840701 Originally created by @mdragon on Tue, 10 Sep 2024 13:42:50 GMT


I think 3 sounds like the best option having nearly zero background information.