darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-01 07:35:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix issues and update ADRs (#303)

Browse Source 
This changeset fixes a few lingering typos and incorrect information in the ADRs and updates them with some final decisions.  It also fixes an issue with the ADR creation form for GitHub.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2023-06-20 16:51:32 -04:00
committed by GitHub
parent 23ce2ec8c3
commit e89d30bfd7
5 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/create-new-adr-form.yml vendored
View File

@@ -42,8 +42,8 @@ body:
label: Implemented label: Implemented
description: Is this ADR implemented? description: Is this ADR implemented?
options: options:
- Yes - 'Yes'
- No - 'No'
validations: validations:
required: true required: true
- type: input - type: input

10
docs/adrs/0001-establishing-adrs-for-us-notify.md
View File

@@ -3,7 +3,7 @@
| CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS | | CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS |
| :---: | :---: | :---: | :---: | :---: | | :---: | :---: | :---: | :---: | :---: |
| 06/01/2023 | 06/05/2023 | Accepted | @ccostino | @stvnrlly | | 06/01/2023 | 06/15/2023 | Accepted | @ccostino | @stvnrlly |
## CONTEXT AND PROBLEM STATEMENT ## CONTEXT AND PROBLEM STATEMENT
@@ -103,11 +103,11 @@ These are the key considerations for creating ADRs for US Notify:
- Requires being mindful of what can live in the public space vs. not - Requires being mindful of what can live in the public space vs. not
## PROPOSED OPTION: Architectural Decision Records ## CHOSEN OPTION: Architectural Decision Records
I am proposing that our team adopts using Architectural Decision Records going Our team has chosen to adopt Architectural Decision Records going forward for
forward for any decisions that need to be proposed or discussed that will have a any decisions that need to be proposed or discussed that will have a significant
significant impact on the platform. impact on the platform.
By documenting our changes in this fashion, it will improve our team's By documenting our changes in this fashion, it will improve our team's
development practices and software quality in a few ways: development practices and software quality in a few ways:

4
docs/adrs/0002-how-to-handle-timezones.md
View File

@@ -3,7 +3,7 @@
| CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS | | CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS |
| :---: | :---: | :---: | :---: | :---: | | :---: | :---: | :---: | :---: | :---: |
| 06/06/2023 | N/A | Accepted | @terrazoon, @ccostino | @GSA/notify-contributors | | 06/06/2023 | 06/15/2023 | Accepted | @terrazoon, @ccostino | @GSA/notify-contributors |
## CONTEXT AND PROBLEM STATEMENT ## CONTEXT AND PROBLEM STATEMENT
@@ -106,7 +106,7 @@ Cons of converting parts of the frontend now:
customization, if any. customization, if any.
## PROPOSED OR CHOSEN OPTION: Proposed/Chosen Option Title Here ## CHOSEN OPTION: Backend UTC, frontend UTC
After talking through each of these options together as a team, we have decided After talking through each of these options together as a team, we have decided
to move forward with converting the backend to UTC fully and pairing that work to move forward with converting the backend to UTC fully and pairing that work

4
docs/adrs/0003-implementing-invite-expirations.md
View File

@@ -3,7 +3,7 @@
| CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS | | CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS |
| :---: | :---: | :---: | :---: | :---: | | :---: | :---: | :---: | :---: | :---: |
| 06/06/2023 | N/A | Proposed | @ccostino | @GSA/notify-contributors | | 06/06/2023 | 06/15/2023 | Proposed | @ccostino | @GSA/notify-contributors |
## CONTEXT AND PROBLEM STATEMENT ## CONTEXT AND PROBLEM STATEMENT
@@ -82,7 +82,7 @@ change:
(especially any related to scheduled jobs). (especially any related to scheduled jobs).
## PROPOSED OR CHOSEN OPTION: Proposed/Chosen Option Title Here ## PROPOSED OPTION: Adjust `InvitedUser` management in the API
I am proposing we adjust the `InvitedUser` management in the API and get these I am proposing we adjust the `InvitedUser` management in the API and get these
updates in place first for future UI changes, because without them we cannot updates in place first for future UI changes, because without them we cannot

6
docs/adrs/README.md
View File

@@ -172,6 +172,6 @@ top!).
| ADR | TITLE | CURRENT STATUS | IMPLEMENTED | LAST MODIFIED | | ADR | TITLE | CURRENT STATUS | IMPLEMENTED | LAST MODIFIED |
| :---: | :---: | :---: | :---: | :---: | | :---: | :---: | :---: | :---: | :---: |
| [ADR-0003](./0003-implementing-invite-expirations.md) | [Implementing User Invite Expirations](./0003-implementing-invite-expirations.md) | Proposed | No | 06/06/2023 | | [ADR-0003](./0003-implementing-invite-expirations.md) | [Implementing User Invite Expirations](./0003-implementing-invite-expirations.md) | Proposed | No | 06/15/2023 |
| [ADR-0002](./0002-how-to-handle-timezones.md) | [Determine How to Handle Timezones in US Notify](./0002-how-to-handle-timezones.md) | Accepted | Yes | 06/06/2023 | | [ADR-0002](./0002-how-to-handle-timezones.md) | [Determine How to Handle Timezones in US Notify](./0002-how-to-handle-timezones.md) | Accepted | Yes | 06/15/2023 |
| [ADR-0001](./0001-establishing-adrs-for-us-notify.md) | [Establishing ADRs for US Notify](./0001-establishing-adrs-for-us-notify.md) | Accepted | Yes | 06/05/2023 | | [ADR-0001](./0001-establishing-adrs-for-us-notify.md) | [Establishing ADRs for US Notify](./0001-establishing-adrs-for-us-notify.md) | Accepted | Yes | 06/15/2023 |