Merge branch 'develop' into tasks-update

AnikaLegal · Nov 3, 2023 · eb49a19 · eb49a19
2 parents a6dd645 + 83b61f7
commit eb49a19
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ See here for documentation:
 
 - [Changelog](docs/changelog.md)
 - [Getting started](docs/setup.md)
-- [Testing and linting](docs/tests.md)
+- [Testing](docs/tests.md)
 - [Infra and deployment](docs/infra.md)
 - [Email integration](docs/emails.md)
 - [Twilio integration](docs/twilio.md)

diff --git a/docs/emails.md b/docs/emails.md
@@ -15,7 +15,7 @@ Each environment (dev/test/prod) has its own email subdomain.
 
 The events webhook needs to be configured manually and is difficult to test because we only get one webhook (which we use for production).
 
-To listen for inbound emails in your development environment run [ngrok](https://ngrok.com/). This will print the public endpoint, e.g "https://90c8-194-193-130-131.ngrok.io".
+To listen for inbound emails in your development environment run [ngrok](https://ngrok.com/). This will print the public endpoint, e.g. "https://90c8-194-193-130-131.ngrok.io".
 
 ```bash
 # Start ngrok (https://ngrok.com/) and take note of the address

diff --git a/docs/infra.md b/docs/infra.md
@@ -40,6 +40,6 @@ Infra config can be found in the [infra](https://github.com/AnikaLegal/infra) re
 
 ## Logging and Error Reporting
 
-- All application logs are logged to [Papertrail](https://papertrailapp.com/systems/Clerk/events).
+- All application logs are logged to [Sumo Logic](https://service.au.sumologic.com/ui/).
 - Errors are reported to [Sentry](https://sentry.io/organizations/anika-legal/projects/).
 - Application uptime is tracked by [StatusCake](https://app.statuscake.com/YourStatus.php).
diff --git a/docs/setup.md b/docs/setup.md
@@ -9,6 +9,12 @@ You will need:
 - `transcrypt` ([install](https://github.com/elasticdog/transcrypt#usage))
 - `inv` ([install](https://www.pyinvoke.org/installing.html))
 
+## Optional for Local Development
+
+- `ngrok` ([install](https://docs.docker.com/install/#supported-platforms))
+
+  For testing inbound emails.
+
 ## Getting Started
 
 If you are using Windows ensure that git is setup to use LF not CLRF

diff --git a/docs/tests.md b/docs/tests.md
@@ -3,24 +3,12 @@
 This app has unit tests which are run automatically in GitHub Actions. If you are making changes, please run them:
 
 ```
-make test
+inv test
 ```
 
 To run specific tests
 
 ```
 docker-compose -f docker/docker-compose.local.yml run --rm test bash
-pytest case/tests/test_urls.py -vv
-```
-
-The Python code is formatted with Black. To check the code with the linter run:
-
-```
-make lint
-```
-
-To automatically fix any linting errors, run:
-
-```
-make format
+pytest path/to/test.py -vv
 ```