Commit Graph
176 Commits
Author SHA1 Message Date
Carlo Costino 0a28b33e99 Add detect-secrets documentation
This changeset adds documentation to help our team manage our secrets detection with the detect-secrets pre-commit plugin.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-05-30 11:39:07 -04:00
Alex Janousekandccostino cb750e1689 Update docs/openapi.yml
Co-authored-by: ccostino <ccostino@users.noreply.github.com>
2025-05-20 13:13:39 -04:00
alexjanousekGSA 68b4cd30f5 Added false positive fix for scan 2025-05-20 09:39:35 -04:00
Carlo Costino debb14d216 Updated Login.gov section
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-04-28 17:15:08 -04:00
Carlo Costino 01b9ea451a Expand the credential/secret rotation runbook
This changeset adds a bunch of new information on how to manage environment variables and credentials in our application.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-04-28 17:01:59 -04:00
Carlo Costino 4c91629ee8 Add runbook for reviewing daily scans
This changeset adds a new runbook to our documentation that explains how to review our daily scans for new findings.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-04-28 11:36:44 -04:00
Carlo Costino 6824c45909 Fix typos and clarify a couple more things
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-04-25 15:17:42 -04:00
Carlo Costino e8214e4a01 Update instructions for managing DNS and domain configuration
This changeset updates our runbook for the DNS and domain management:

* Add instructions and steps for how to perform the necessary actions to add and/or remove domains
* Update links to existing resources
* Add links to additional documentation

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2025-04-25 13:39:17 -04:00
Kenneth Kehlandccostino d99661863f Update docs/all.md
Co-authored-by: ccostino <ccostino@users.noreply.github.com>
2025-04-22 07:08:02 -07:00
Kenneth Kehl 0a6bbe035a refreshing login.gov cert instructions 2025-04-21 10:13:49 -07:00
ecayer 1af4b4c764 Create reflection.md
Notes reflecting on the state of the codebase.
2025-03-14 15:07:47 -07:00
Kenneth Kehl 4cfb980ac6 add debug tag adr 2025-02-27 13:24:32 -08:00
Kenneth Kehl 3e60fd7281 add report generation adr 2025-02-12 12:17:25 -08:00
Kenneth Kehl 669f4e9bfd bulk_update_mappings adr 2025-01-22 09:40:59 -08:00
Kenneth Kehl 738b4f063e add adr 2024-11-25 12:17:38 -08:00
Carlo Costino 469103d4f1 Make sandbox deployments easier
This changeset makes a few adjustments to our sandbox environment config to make the sandbox deployments of the API much easier.  It does this with the following:

* Adds a few environment variable values to the sandbox.yml file to cover the ones that were not there previously
* Adds a new script that can be run in place of memorizing any commands
* Adds documentation on how to configure and run the sandbox environment

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-11-12 21:50:27 -05:00
alexjanousekGSA 1af2a42742 Added section about feature flagging 2024-11-07 12:24:34 -05:00
Kenneth Kehl 76eb5281cf add documentation for how to rotate DANGEROUS_SALT 2024-10-01 07:31:51 -07:00
Carlo Costino 51ac7bd37d Add production deployment steps to documentation
This changeset adds the steps to take for setting up a new production deployment.  This includes instructions on creating the release notes and what to do once the deploys are done (and if they fail, what to do to help troubleshoot).

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-09-10 14:44:58 -04:00
Carlo Costino 17b41eeefa Change BackstopJS ADR (0009) to accepted and add more details
This changeset updates ADR 0009 - BackstopJS integration - to be accepted now that it has undergone some review.

It also adds a few extra details about what the next steps will look like with firmer language that we will be integrating this as a new job in our CI/CD process.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-09-04 16:56:08 -04:00
Alex JanousekandCarlo Costino e487b50acf Apply suggestions from code review
Co-authored-by: Carlo Costino <ccostino@users.noreply.github.com>
2024-08-28 09:44:12 -04:00
alexjanousekGSA 4301f7a8d4 Added new ADR for BackstopJS 2024-08-27 12:33:08 -04:00
Kenneth Kehl 030a9b5daa add documentation on search tags 2024-08-21 10:59:49 -07:00
ecayer 8a01275ada Update all.md
Updated phone number list.
2024-08-13 14:44:20 -07:00
Kenneth Kehl 0ab937346d change to actually downloading file 2024-08-01 08:05:12 -07:00
John Skiles Skinner 9ee7959211 Remove manual Network Policy creation step from all.md 2024-07-25 19:40:10 -07:00
John Skiles Skinner 74d0b40e16 Doc updates, including setting Network Policy 2024-07-24 14:11:12 -07:00
Kenneth Kehl 86c9065a44 use click.echo 2024-07-23 07:47:35 -07:00
John Skiles Skinner be360cd82b Complete link to Troubleshooting section 2024-07-22 15:49:19 -07:00
John Skiles Skinner 2ac0ae73ce Update table of contents 2024-07-22 15:47:42 -07:00
John Skiles Skinner 3eb34158e3 Notes about push command, URLs for Sandbox 2024-07-22 15:41:38 -07:00
John Skiles Skinner bce064fa0c Start troubleshooting section, add errors seen in sandboxing 2024-07-22 15:31:01 -07:00
John Skiles Skinner a237621bbd Specify directory 2024-07-17 14:23:34 -07:00
John Skiles Skinner 0d3c297b16 Fix typo and clarify a thing 2024-07-17 09:23:51 -07:00
John Skiles Skinner 9edfbefbed Link to README from the all instructions doc 2024-07-16 15:42:39 -07:00
Kenneth Kehl 7f33e4445c add debug steps 2024-07-03 10:18:17 -07:00
Kenneth Kehl 723b89da51 fix command syntax 2024-07-03 08:44:13 -07:00
Kenneth Kehl 3471bf45c8 merge from main 2024-07-02 08:51:07 -07:00
Kenneth Kehl 141dd51b52 code review feedback 2024-07-02 08:50:48 -07:00
Kenneth Kehl 9a4dd043ce cleanup 2024-07-01 10:52:03 -07:00
Carlo Costino df31d43a92 Update pull request template and docs
This changeset updates our pull request template to be much more streamlined and shifts most of the information to our documentation.  The PR template now links to the docs for folks who are new and unfamiliar with what we require in our pull requests so that the template itself just has the headings and quick outlines to get started more easily and quickly.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-06-28 17:22:30 -04:00
Kenneth Kehl 5b2446ec62 add examples of common commands 2024-04-08 09:35:51 -07:00
John Skiles Skinner 3db2606d6a Move createdb step
The command `createdb test_notification_api` is a prereq to running `make test`. Clarify that it is not just a troubleshooting step.
2024-04-02 08:53:49 -07:00
John Skiles Skinner c1f25e7c10 Add a note about how to resolve db error
Apparently this error is common:
```
FATAL:  database "test_notification_api" does not exist
```

In lieu of getting to the bottom of it, add a note about how to fix it
2024-04-01 16:53:02 -07:00
Andrew Shumway a0e2f0fbc8 Merge branch 'main' of https://github.com/GSA/notifications-api into message-send-flow-docs 2024-03-27 10:33:05 -06:00
Jonathan Bobel 232bbd2d8a Merge branch 'main' of https://github.com/GSA/notifications-api into 673-data-dictionary 2024-03-20 11:25:24 -04:00
Andrew Shumway 5f2508a975 Add docs/code comments for message send flow 2024-03-18 11:32:29 -06:00
Carlo Costino df9ee470dc Merge pull request #828 from GSA/800-flask-command-for-test
800 flask command for test
2024-03-05 11:58:00 -05:00
Anastasia Gradova 703500274b Updated doucmentation in README and all.md 2024-03-05 08:43:20 -07:00
Anastasia Gradova ee6dfacad1 Standardized command names and updated
documentation
2024-03-04 14:34:41 -07:00