diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.md b/.github/ISSUE_TEMPLATE/i-have-an-issue.md index ae585db0..dafdf6ff 100755 --- a/.github/ISSUE_TEMPLATE/i-have-an-issue.md +++ b/.github/ISSUE_TEMPLATE/i-have-an-issue.md @@ -7,24 +7,19 @@ assignees: '' --- -**Describe the issue** +## Describe the issue +> When submitting an issue ❗[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)❗ and [have a look at the docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs) -**Paste last few lines from `pialert.log`** +[describe your issue] -> You can use `tail -20 /home/pi/pialert/front/log/pialert.log` +## Paste your `pialert.conf` (remove personal info) ``` paste_here ``` -**Paste your `pialert.conf` (remove personal info)** - -``` -paste_here -``` - -**Paste your `docker-compose.yml` and `.env` (remove personal info)** +## Paste your `docker-compose.yml` and `.env` (remove personal info)** `docker-compose.yml` @@ -38,5 +33,14 @@ paste_here paste_here ``` -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Screenshots + +[If applicable, add screenshots to help explain your problem.] + +## Paste last few lines from `pialert.log` + +> You can use `tail -100 /home/pi/pialert/front/log/pialert.log` + +```bash + +# paste_here diff --git a/docs/DEBUG_TIPS.md b/docs/DEBUG_TIPS.md index 46f6986c..32793931 100755 --- a/docs/DEBUG_TIPS.md +++ b/docs/DEBUG_TIPS.md @@ -62,6 +62,10 @@ services: * Check that your `SCAN_SUBNETS` variable is using the correct mask and `--interface` as outlined in the instructions above. +### Invalid JSON + +Check the [Invalid JSON errors debug help](/docs/DEBUG_INVALID_JSON.md) docs on how to proceed. + ### sudo execution failing (e.g.: on arpscan) on a Raspberry Pi 4 > sudo: unexpected child termination condition: 0