Skip to content

Commit 4bb3546

Browse files
Merge branch 'main' into sjp/connecting
2 parents ec5e3f1 + a30f029 commit 4bb3546

File tree

1 file changed

+22
-55
lines changed

1 file changed

+22
-55
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -139,71 +139,38 @@ You can review the use of those tools by running `make` or `bin/npr --help` at t
139139
`bin/npr` is a runner for managing complex `docker compose run` commands across the various services that make up this project.
140140

141141
### Troubleshooting
142-
#### 1. PostgreSQL collation version mismatch
143-
144-
**Error**
145-
```
146-
ERROR: template database "template1" has a collation version mismatch
147-
```
148142

149-
**Cause**
150-
```
151-
A PostgreSQL Docker volume was created using a different system library version
152-
```
153-
**Fix**
154-
This should automatically be resolved by the Flyway migration `R__refresh_collation_version.sql`.
143+
#### 1. PostgreSQL collation version mismatch
155144

156-
#### 2. Docker volume image mismatch
145+
| | |
146+
|---|---|
147+
| **Error** | `template database "template1" has a collation version mismatch` |
148+
| **Cause** | A PostgreSQL Docker volume was created using a different system library version. |
149+
| **Fix** | Automatically resolved by the Flyway migration `R__refresh_collation_version.sql`. |
157150

158-
**Error**
159-
```
160-
ERROR: extension "postgis" already exists
161-
```
151+
#### 2. Docker volume image mismatch
162152

163-
**Cause**
164-
```
165-
Mismatch of Docker database images due to deprecated older code or a partially completed migration
166-
```
167-
**Fix**
168-
```
169-
make reset-db
170-
make setup
171-
```
153+
| | |
154+
|---|---|
155+
| **Error** | `extension "postgis" already exists` |
156+
| **Cause** | Mismatch of Docker database images due to deprecated older code or a partially completed migration. |
157+
| **Fix** | Run `make reset-db` then `make setup`. |
172158

173159
#### 3. Port already in use
174160

175-
**Error**
176-
```
177-
bind: address already in use
178-
```
179-
180-
**Cause**
181-
```
182-
Another local service is already using a required port
183-
```
184-
**Fix**
185-
```
186-
sudo lsof -i :{port}
187-
sudo kill <PID>
188-
```
161+
| | |
162+
|---|---|
163+
| **Error** | `bind: address already in use` |
164+
| **Cause** | Another local service is already using a required port. |
165+
| **Fix** | Run `sudo lsof -i :{port}` to find the process, then `sudo kill <PID>`. |
189166

190167
#### 4. Updated elements do not appear on the frontend after build
191168

192-
**Error**
193-
```
194-
Elements do not appear after either pulling a branch or creating new code
195-
```
196-
197-
**Cause**
198-
```
199-
Cached frontend assets or stale build artifacts are being served by the browser or container
200-
```
201-
**Fix**
202-
```
203-
CMD + Shift + R
204-
make clean-frontend
205-
make build-frontend-assets
206-
```
169+
| | |
170+
|---|---|
171+
| **Error** | Elements do not appear after either pulling a branch or creating new code. |
172+
| **Cause** | Cached frontend assets or stale build artifacts are being served by the browser or container. |
173+
| **Fix** | Hard refresh with `Cmd + Shift + R`, or run `make clean-frontend` then `make build-frontend-assets`. |
207174

208175
### Workflow and Branching
209176

0 commit comments

Comments
 (0)