Commit Graph

160 Commits

Author SHA1 Message Date
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
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
Carlo Costino
ac4ebacfeb Removed one more utils reference in the README and fixed directory name
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2024-05-16 10:41:49 -04:00
Carlo Costino
99edc88197 Localize notification_utils to the API
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>
2024-05-16 10:17:45 -04:00
John Skiles Skinner
dbfb1e2379 Accommodate the version of Terraform that CI/CD expects 2024-04-15 17:52:40 -07:00
John Skiles Skinner
dc6379bae7 Update version of Terraform installed in the main README 2024-04-15 16:51:32 -07:00
John Skiles Skinner
8d11133d4e Merge pull request #875 from GSA/jskinne3-add-cf-org-and-space
Add cf org and space to README
2024-03-27 17:32:04 -07:00
John Skiles Skinner
387e37629b Clarify local development context 2024-03-27 17:24:24 -07:00
John Skiles Skinner
7b97013255 Notes about running ./run.sh and make run-profile
Explain what to expect when running `./run.sh` and `make run-profile` so that the user can determine if they have run correctly
2024-03-27 09:05:08 -07:00
John Skiles Skinner
6b870abdc4 Add cf org and space to README 2024-03-26 13:08:34 -07:00
samathad2023
61ce2b08b8 utils dependencies updates 2024-03-21 13:02:54 -07:00
samathad2023
172497c19e Latest utils commit updates sync with main 2024-03-20 14:09:46 -07:00
samathad2023
aa0b2e49e1 README updates 2024-03-19 09:18:46 -07:00
Steven Reilly
89200e5f4d Update README.md with logo 2024-03-06 14:18:01 -05: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
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
Anastasia Gradova
96a3a8bdc6 Update README.md
Co-authored-by: Carlo Costino <ccostino@users.noreply.github.com>
2023-12-18 13:22:03 -07:00
Anastasia Gradova
3f903d9fe2 updated README for PSQL bug 2023-12-08 12:39:57 -07:00
stvnrlly
24c2bb6f11 apparently another heading 2023-11-28 13:12:12 -05:00
stvnrlly
33d1fd4534 one fewer t 2023-11-28 13:10:37 -05:00
Carlo Costino
b066fff07c ...and the README
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-28 12:44:32 -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
Carlo Costino
b2f91cc533 Minor README.md updates
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>
2023-11-22 10:21:22 -05:00
Carlo Costino
ba7c310fdd Adds additional instructions for virtual environments
h/t to @xlorepdarkhelm for the suggestions!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 15:10:07 -05:00
Carlo Costino
a28120ec64 Minor formatting adjustments of notes.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1859669a6d Added missing feedback about PostgreSQL versions
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1ee9b73832 Improvements based on review feedback
h/t to @stvnrlly for the suggestions!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1b8fb4206d Fixed brew install command
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
dd571152b7 More minor adjustments
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
1815028aac Plain-language, grammatical, and formatting adjustments
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-11-17 12:16:47 -05:00
Carlo Costino
7c1fa1bd75 Update README with new instructions and improve setup
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>
2023-11-17 12:16:44 -05:00
Beverly Nguyen
a28358c0db updated readme 2023-11-14 09:34:50 -08:00
Carlo Costino
d6d11746b1 Update more dependencies and fix notifications-utils
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>
2023-11-01 12:15:53 -04:00
Carlo Costino
4b2586cd3b Added instructions to the README
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
2023-10-30 16:56:40 -04:00
Steven Reilly
96b224d159 streamline setup instructions 2023-09-29 10:36:39 -04:00
stvnrlly
04bd91758b update doc links in readme 2023-09-18 16:50:52 -04:00
stvnrlly
d345b21546 update pipenv references 2023-09-05 12:19:42 -04:00
stvnrlly
dd0bf646c4 reorder docs 2023-08-28 12:08:06 -04:00
stvnrlly
25af2df15c combine all docs together, to be cleaned up 2023-08-22 17:36:00 -04:00
Carlo Costino
babdd70839 Add Architectural Decision Records to US Notify (#284)
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>
2023-06-06 15:34:01 -04:00
Steven Reilly
881f479417 Small doc updates (#253) 2023-05-02 10:25:02 -04:00
Ryan Ahearn
9eb075f074 Address PR feedback 2023-03-14 15:36:32 -04:00
Steven Reilly
886db509a0 update docs for project setup (#190) 2023-03-07 09:56:12 -05:00
stvnrlly
9a1df7cf06 link to new doc in readme 2022-11-30 11:59:04 -05:00
stvnrlly
b50cb4712f tz utility swap and many test updates 2022-11-10 12:33:25 -05:00
stvnrlly
57adbf3f6b document create-test-user command 2022-11-01 12:14:26 -04:00
Ryan Ahearn
db96c4d82f Replace foreman with honcho 2022-11-01 09:54:31 -04:00
Ryan Ahearn
55bccecf10 Merge branch 'main' into cleanup-config
* main:
  add the requirements.txt file during deploy 🤷
  add versions in pipfile for git deps
  use setup action in deploy workflow
  include new/renamed files
  update licensing situation for us gov
2022-11-01 09:39:52 -04:00
Ryan Ahearn
a4aedee572 Add Procfile.dev to ease running of flask & celery in dev 2022-11-01 09:35:55 -04:00