Commit Graph

59 Commits

Author SHA1 Message Date
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
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
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
Carlo Costino
611a8c8bc6 Add E2E configuration information to docs
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>
2024-03-01 12:23:05 -05:00
Carlo Costino
755f5e085e Update reviewee to author
This changeset adjusts the language slightly to use clearer terms for the individuals involved in a code review.
2024-02-13 16:27:55 -05:00
Carlo Costino
aabb822824 Added a couple of notes about engaging in conversation
h/t to @stvnrlly for the suggestion!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-02-12 13:27:29 -05:00
Carlo Costino
d9e6ebdbe3 Add code review documentation
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>
2024-02-12 13:23:27 -05:00
Tim Lowden
c422f8eb4d Update all.md
Adding link to spreadsheet
2024-01-10 14:33:05 -05:00
Emily Herrick
e1dcd12d2d Production phone number assignments
Edited production phone numbers to assign the ones in use to three pilot partners with live services.
2024-01-08 14:05:30 -05:00
Carlo Costino
8ecfed4544 Expand one-off task details
This changeset adds a bit more information to the one-off task details and helps clarify what to include in the command to pass to Cloud Foundry.
2023-12-08 10:28:12 -05:00
stvnrlly
33d1fd4534 one fewer t 2023-11-28 13:10:37 -05:00
Carlo Costino
7d145a0872 Added new section to the table of contents
h/t to @stvnrlly for catching that!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-28 11:41:20 -05:00
Carlo Costino
9794f82f44 Add .profile file information to docs
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>
2023-11-24 16:34:14 -05:00
Carlo Costino
844cab2e3d Updated references of US Notify to Notify.gov
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-22 13:53:15 -05:00
stvnrlly
b9db94adbb note about running independently 2023-11-17 09:50:02 -05:00
stvnrlly
63952e35a9 freshen up files 2023-11-17 09:47:32 -05:00
Steven Reilly
dfa729d5c7 update onboarding docs 2023-10-31 11:13:29 -04:00
Carlo Costino
669f2ec813 Merge pull request #535 from GSA/stvnrlly/deploy-docs
Adding details of deploy PR process to docs
2023-10-13 13:50:30 -04:00
stvnrlly
d851d848f4 add info about deploy pr 2023-10-13 11:06:52 -04:00
Steven Reilly
e809c30f3d add new phone numbers to docs 2023-10-12 14:38:30 -04:00
Kenneth Kehl
27197b60bb code review feedback 2023-09-29 07:30:12 -07:00
Steven Reilly
6c6762b2ce Update docs/all.md
Co-authored-by: Carlo Costino <ccostino@users.noreply.github.com>
2023-09-22 21:59:47 -04:00
Steven Reilly
ec48d436d6 Update docs/all.md
Co-authored-by: Carlo Costino <ccostino@users.noreply.github.com>
2023-09-22 21:59:24 -04:00