From 8eecc5421776f1cdfa79a8f2a5c87ffd50e47bb7 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sun, 7 Jan 2024 11:18:52 +1100 Subject: [PATCH] =?UTF-8?q?docs=20=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING | 2 +- docs/DEBUG_TIPS.md | 2 +- docs/README.md | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 97b66221..fb332236 100755 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -6,7 +6,7 @@ The issue tracker is the preferred channel for bug reports, features requests an Before submitting a new issue please spend a couple of minutes on research: -* Check [๐Ÿ›‘ Common issues](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#-common-issues) +* Check [๐Ÿ›‘ Common issues](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md#common-issues) * Check [๐Ÿ’ก Closed issues](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past. ## Pull-requests (PRs) diff --git a/docs/DEBUG_TIPS.md b/docs/DEBUG_TIPS.md index 47305d59..3043be95 100755 --- a/docs/DEBUG_TIPS.md +++ b/docs/DEBUG_TIPS.md @@ -56,7 +56,7 @@ services: * If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/home/pi/pialert/front/log`. * To solve permission issues you can try setting the owner and group of the `pialert.db` by executing the following on the host system: `docker exec pialert chown -R www-data:www-data /home/pi/pialert/db/pialert.db`. * Map to local User and Group IDs. Specify the enviroment variables `HOST_USER_ID` and `HOST_USER_GID` if needed. -* If still facing issues, try to map the pialert.db file (โš  not folder) to `:/home/pi/pialert/db/pialert.db` (see Examples below for details) +* If still facing issues, try to map the pialert.db file (โš  not folder) to `:/home/pi/pialert/db/pialert.db` (see [docker-compose Examples](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details) ### Container restarts / crashes diff --git a/docs/README.md b/docs/README.md index 3bed8e38..51cbb71b 100755 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a - [(Experimental ๐Ÿงช) On-hardware instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HW_INSTALL.md) -- Alternative forks: +- Alternative bare-metal install forks: - [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained) - [pucherot's original code](https://github.com/pucherot/Pi.Alert/) (un-maintained) @@ -43,7 +43,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a - [Manage devices (legacy docs)](/docs/DEVICE_MANAGEMENT.md) - [Random MAC/MAC icon meaning (legacy docs)](/docs/RANDOM_MAC.md) -- [Custom Icons configuration and support](/docs/ICONS.md) +- [Custom Icon configuration and support](/docs/ICONS.md) #### ๐Ÿ”Ž Examples @@ -108,7 +108,7 @@ Suggested test cases: - Blank setup with no DB or config - Existing DB / config - Sending a notification (e. g. Delete a device and wait for a scan to run) and testing all notification gateways, especially: -- Email, Apprise (e.g. via Telegram), webhook (e.g. via Discord), MQTT (e.g. via HomeAssitant) + - Email, Apprise (e.g. via Telegram), webhook (e.g. via Discord), MQTT (e.g. via Home Assistant) - Saving settings - Test a couple of plugins - Check the Error log for anything unusual @@ -122,7 +122,7 @@ Some additional context: Before submitting a new issue please spend a couple of minutes on research: -* Check [๐Ÿ›‘ Common issues](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#-common-issues) +* Check [๐Ÿ›‘ Common issues](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md#common-issues) * Check [๐Ÿ’ก Closed issues](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past. * When submitting an issue โ—[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)โ—