mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-10 23:32:27 -05:00
combine all docs together, to be cleaned up
This commit is contained in:
77
README.md
77
README.md
@@ -15,31 +15,6 @@ Our other repositories are:
|
||||
- [us-notify-compliance](https://github.com/GSA/us-notify-compliance/)
|
||||
- [notify-python-demo](https://github.com/GSA/notify-python-demo)
|
||||
|
||||
## Documentation, here and elsewhere
|
||||
|
||||
### About Notify
|
||||
|
||||
- [Roadmap](https://notifications-admin.app.cloud.gov/features/roadmap)
|
||||
- [Using the API](./docs/api-usage.md)
|
||||
- [Architectural Decision Records](./docs/adrs/)
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- [Overview, setup, and onboarding](./docs/infra-overview.md)
|
||||
- [Database management](./docs/database-management.md)
|
||||
- [Celery queues and tasks](./docs/queues-and-tasks.md)
|
||||
|
||||
### Common dev work
|
||||
|
||||
- [Local setup](#local-setup)
|
||||
- [Testing](./docs/testing.md), both automated and manual
|
||||
- [Deploying](./docs/deploying.md)
|
||||
- [Running one-off tasks](./docs/one-off-tasks.md)
|
||||
|
||||
## UK docs that may still be helpful
|
||||
|
||||
- [Writing public APIs](docs/writing-public-apis.md)
|
||||
- [Updating dependencies](https://github.com/alphagov/notifications-manuals/wiki/Dependencies)
|
||||
|
||||
## Local setup
|
||||
|
||||
@@ -123,10 +98,60 @@ On M1 Macs, if you get a `fatal error: 'Python.h' file not found` message, try a
|
||||
|
||||
A direct installation of PostgreSQL will not put the `createdb` command on your `$PATH`. It can be added there in your shell startup script, or a Homebrew-managed installation of PostgreSQL will take care of it.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Deploying](#deploying)
|
||||
- [Egress Proxy](#egress-proxy)
|
||||
- [Sandbox environment](#sandbox-environment)
|
||||
- [Infrastructure overview](#infrastructure-overview)
|
||||
- [GitHub Repositories](#github-repositories)
|
||||
- [Terraform](#terraform)
|
||||
- [AWS](#aws)
|
||||
- [New Relic](#new-relic)
|
||||
- [Onboarding](#onboarding)
|
||||
- [Setting up the infrastructure](#setting-up-the-infrastructure)
|
||||
- [Database management](#database-management)
|
||||
- [Initial state](#initial-state)
|
||||
- [Data Model Diagram](#data-model-diagram)
|
||||
- [Migrations](#migrations)
|
||||
- [Purging user data](#purging-user-data)
|
||||
- [Testing](#testing)
|
||||
- [CI testing](#ci-testing)
|
||||
- [Manual testing](#manual-testing)
|
||||
- [To run a local OWASP scan](#to-run-a-local-owasp-scan)
|
||||
- [One-off tasks](#one-off-tasks)
|
||||
- [How messages are queued and sent](#how-messages-are-queued-and-sent)
|
||||
- [Writing public APIs](#writing-public-apis)
|
||||
- [Overview](#overview)
|
||||
- [Documenting APIs](#documenting-apis)
|
||||
- [New APIs](#new-apis)
|
||||
- [API Usage](#api-usage)
|
||||
- [Connecting to the API](#connecting-to-the-api)
|
||||
- [Postman Documentation](#postman-documentation)
|
||||
- [Using OpenAPI documentation](#using-openapi-documentation)
|
||||
- [Queues and tasks](#queues-and-tasks)
|
||||
- [Priority queue](#priority-queue)
|
||||
- [Celery scheduled tasks](#celery-scheduled-tasks)
|
||||
- [US Notify](#us-notify)
|
||||
- [System Description](#system-description)
|
||||
- [Run Book](#run-book)
|
||||
- [ Alerts, Notifications, Monitoring](#-alerts-notifications-monitoring)
|
||||
- [ Restaging Apps](#-restaging-apps)
|
||||
- [ Smoke-testing the App](#-smoke-testing-the-app)
|
||||
- [ Configuration Management](#-configuration-management)
|
||||
- [ DNS Changes](#-dns-changes)
|
||||
- [Exporting test results for compliance monitoring](#exporting-test-results-for-compliance-monitoring)
|
||||
- [ Known Gotchas](#-known-gotchas)
|
||||
- [ User Account Management](#-user-account-management)
|
||||
- [ SMS Phone Number Management](#-sms-phone-number-management)
|
||||
- [Data Storage Policies \& Procedures](#data-storage-policies--procedures)
|
||||
- [Potential PII Locations](#potential-pii-locations)
|
||||
- [Data Retention Policy](#data-retention-policy)
|
||||
|
||||
## License && public domain
|
||||
|
||||
Work through [commit `e604385`](https://github.com/GSA/notifications-api/commit/e604385e0cf4c2ab8c6451b7120ceb196cce21b5) is licensed by the UK government under the MIT license. Work after that commit is in the worldwide public domain. See [LICENSE.md](./LICENSE.md) for more information.
|
||||
|
||||
## Contributing
|
||||
|
||||
As stated in [CONTRIBUTING.md](CONTRIBUTING.md), all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
|
||||
As stated in [CONTRIBUTING.md](CONTRIBUTING.md), all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
|
||||
Reference in New Issue
Block a user