From 83b61f78bba070145c1dd33213a3f4301e7998f0 Mon Sep 17 00:00:00 2001
From: Luca Vari <45747588+luca-vari@users.noreply.github.com>
Date: Fri, 3 Nov 2023 12:02:49 +1100
Subject: [PATCH] Docs update (#106)

Minor changes to the clerk documentation mostly to update or remove redundant info.
---
 README.md      |  2 +-
 docs/emails.md |  2 +-
 docs/infra.md  |  2 +-
 docs/setup.md  |  6 ++++++
 docs/tests.md  | 16 ++--------------
 5 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 15cd9894..4e911a67 100644
--- 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
index 14eb7cb1..850e1834 100644
--- 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
index 723657af..f7ac385e 100644
--- 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
index ea34c7af..90f4661f 100644
--- 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
index 34224b28..513d77b3 100644
--- 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
 ```