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>
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>
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>
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>
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>
This changeset pulls in all of the notification_utils code directly into the API and removes it as an external dependency. We are doing this to cut down on operational maintenance of the project and will begin removing parts of it no longer needed for the API.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds a bit of missing information to our README and documentation for E2E test configuration. This is required for the project to be set up correctly, and while it will work out of the box, there are a couple of adjustments that need to be made to ensure everything is configured correctly.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset makes a few more adjustments to the README.md file to account for updates in the other repos that are forthcoming.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset updates the README.md file with a set of entirely new instructions. These updates are intended to improve clarity, simplify steps, and reduce confusion and environment-setup gotchas that folks have run into previously and we have learned from. A couple of other changes are also included:
- Minor adjustments to the Makefile to improve make bootstrap
- Updates to the sample.env file to include previously missing required environment variables
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset updates a few more dependencies and addresses the challenges we have had in keeping the notifications-utils dependency up-to-date. The changes include instructions on what to do going forward for future notifications-utils updates.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset introduces Architectural Decision Records (ADRs) to the US Notify project. This initial commit includes the following:
- Updates to the main project README.md that mentions ADRs
- A new adr/ folder under the docs/ folder
- An ADR template to copy and follow for the future
- Our first ADR, ADR-0001 - Establishing ADRs
- A README.md specific to ADRs that has more information and instructions
- ADR-0001 finalized and accepted
A huge thank you to @stvnrlly for the help in making this come together!
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
Co-authored-by: Steven Reilly <stvnrlly@users.noreply.github.com>
