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>
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 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>
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>
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
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 adds documentation for what to expect and how to conduct and receive code reviews. We want to improve our team practices and ensure that all members know how to engage and what to expect with code reviews. Furthermore, this can serve as another model and positive example of how to collaborate as a team in the broader open source community.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds a bit of documentation to explain with the .profile file is used for with our application.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
