Commit Graph

51 Commits

Author SHA1 Message Date
Steven Reilly
881f479417 Small doc updates (#253) 2023-05-02 10:25:02 -04:00
Ryan Ahearn
a46b541ced Update Run Book
added:
* info on relationship to SSPP
* tables to check for audit logs
* how to create and update DNS records for notify.gov
2023-04-28 17:02:17 -04:00
Ryan Ahearn
6d14fb484a Add info on use of reset.sh script to docs/infra-overview.md 2023-04-27 09:17:33 -04:00
Ryan Ahearn
00bfb459ab Merge pull request #239 from GSA/run-book
First cut at an operations run book
2023-04-27 08:54:11 -04:00
Ryan Ahearn
4e6e06e41d Apply suggestions from code review
Co-authored-by: Steven Reilly <stvnrlly@users.noreply.github.com>
2023-04-27 08:39:05 -04:00
Ryan Ahearn
db62e318ca Address moderate and low owasp findings
* CORS headers removed because browsers should not interact with API directly
* Updated error handling to return expected content-type for JSON error messages
2023-04-19 09:27:24 -04:00
Ryan Ahearn
0ac1cd9e53 First cut at an operations run book 2023-04-18 16:27:51 -04:00
Ryan Ahearn
67e9399a22 Clean up sandbox deploy docs 2023-03-31 09:32:13 -04:00
Ryan Ahearn
25c36fea45 Update link to usnotify-ssb 2023-03-27 15:10:36 -04:00
Ryan Ahearn
7ddf125807 Enable SMS in production account 2023-03-21 14:28:32 -04:00
Ryan Ahearn
303595d16b Add warning about database backups 2023-03-20 15:53:30 -04:00
Ryan Ahearn
3a21787089 Add documentation about nightly GitHub Actions scans 2023-03-20 15:50:47 -04:00
Ryan Ahearn
627149402c Add terraform/development for retrieving credentials for local development use 2023-03-13 13:44:10 -04:00
Ryan Ahearn
cb4ab8fb16 Remove obsolete references to AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY 2023-03-03 15:45:04 -05:00
Steven Reilly
ff4190a8eb Remove letters-related code (#175)
This deletes a big ol' chunk of code related to letters. It's not everything—there are still a few things that might be tied to sms/email—but it's the the heart of letters function. SMS and email function should be untouched by this.

Areas affected:

- Things obviously about letters
- PDF tasks, used for precompiling letters
- Virus scanning, used for those PDFs
- FTP, used to send letters to the printer
- Postage stuff
2023-03-02 20:20:31 -05:00
Ryan Ahearn
fd9b730900 Document location of repositories and manual SES steps 2023-02-01 12:09:45 -05:00
Ryan Ahearn
35fdd6132d Add onboarding step for new relic to infra-overview.md 2023-01-23 12:00:58 -05:00
Ryan Ahearn
a218b58151 Update docs/system-description.md
Co-authored-by: Steven Reilly <stvnrlly@users.noreply.github.com>
2023-01-09 12:15:07 -05:00
Ryan Ahearn
7c2e17bf1f Clarify that we are not providing direct access to SES/SNS 2023-01-09 09:34:47 -05:00
Ryan Ahearn
b88de42101 Add a system description entry to docs 2023-01-06 16:20:03 -05:00
Ryan Ahearn
8a0535fa03 Save normalized phone format to DB 2023-01-06 11:06:23 -05:00
Ryan Ahearn
abc7b09d0d Update app to utilize updated phone validation methods 2023-01-05 11:06:12 -05:00
Steven Reilly
d7b889767e simplify to use the script for this exact purpose
Co-authored-by: Ryan Ahearn <ryan.ahearn@gsa.gov>
2022-12-23 11:26:11 -05:00
Steven Reilly
276546fc99 simplify cleanup steps
Co-authored-by: Ryan Ahearn <ryan.ahearn@gsa.gov>
2022-12-23 11:25:44 -05:00
Steven Reilly
036a511e12 update sandbox teardown steps 2022-12-23 10:13:28 -05:00
Ryan Ahearn
0d0db5f6f6 Document potential PII and data storage policies 2022-12-12 16:46:31 -05:00
Ryan Ahearn
b32dbdf199 Add links to postman documentation and other additions to api docs 2022-12-02 11:44:56 -05:00
Ryan Ahearn
34def50f69 Add template list and show API methods to openapi 2022-12-02 11:43:53 -05:00
Ryan Ahearn
0ed7a31765 Merge pull request #126 from GSA/open-api
Add OpenAPI spec for selected api endpoints
2022-11-30 13:30:26 -05:00
stvnrlly
ae25998e52 add some docs about queues, esp what priority is 2022-11-30 11:56:49 -05:00
Ryan Ahearn
e0764a588f Add link to vscode extension for editing openapi 2022-11-21 14:27:10 -05:00
Ryan Ahearn
f9bb5cbb9a Expand docs for external-api call, include link to .gov.uk docs 2022-11-21 12:40:54 -05:00
Ryan Ahearn
1e7d99e853 Fix flake8 and isort findings 2022-11-18 12:39:50 -05:00
Ryan Ahearn
2efed403b1 Add external API for sending SMS to openapi 2022-11-18 12:25:45 -05:00
Ryan Ahearn
f71df236b7 Add more admin api endpoints 2022-11-18 11:43:46 -05:00
Ryan Ahearn
0a9ca6b231 Add organisation and service routes to openapi 2022-11-17 15:47:51 -05:00
Ryan Ahearn
3b7dbddc58 Add /user routes to openapi schema 2022-11-17 10:57:34 -05:00
Ryan Ahearn
7c611e993f Read openapi schema for the owasp scan 2022-11-16 15:50:08 -05:00
Ryan Ahearn
182dd2c28c Document _status routes in openapi 2022-11-16 15:47:51 -05:00
Ryan Ahearn
2e6deb1556 Document egress proxy and sandbox environment within deploying.md 2022-11-08 16:26:59 -05:00
Ryan Ahearn
afd855442b Create demo deploy workflows 2022-11-02 11:36:54 -04:00
stvnrlly
57adbf3f6b document create-test-user command 2022-11-01 12:14:26 -04:00
stvnrlly
64f8641013 improvements from feedback 2022-10-28 12:48:22 -04:00
stvnrlly
9b32bb55ea more ci info 2022-10-28 11:11:17 -04:00
stvnrlly
d87c224473 remove broadcast-related code, except migrations 2022-10-26 16:41:35 -04:00
stvnrlly
56329daa9a more docs 2022-10-26 15:45:45 +00:00
stvnrlly
a45e02d6e5 restructure readme & docs 2022-10-20 14:05:23 -04:00
stvnrlly
57f4df8ed1 remove broadcast-related code, except migrations 2022-10-04 15:28:27 +00:00
Ben Thorner
d1826af3c7 Remove out-of-date docs on new workers
In response to: https://github.com/alphagov/notifications-api/pull/3332#issuecomment-921897641

These were so out-of-date as to be misleading. We can always refer
back to them in the version history if needed.
2021-09-17 16:53:42 +01:00
Ben Thorner
f712bafc7f Add new guidance on writing public APIs
In response to: https://github.com/alphagov/notifications-api/pull/3305#issuecomment-896631475
2021-09-15 17:09:04 +01:00