From 4355bce72e80aea20815ced62fb3c0a841771f37 Mon Sep 17 00:00:00 2001 From: Roland Date: Thu, 23 Nov 2023 17:10:27 -0700 Subject: [PATCH] Moving getting started and getting help into system to avoid cluttery navigation. --- docs/index.md | 4 ++-- docs/{ => system}/getting-help.md | 15 ++++++++------- docs/{ => system}/getting-started.md | 4 ++-- 3 files changed, 12 insertions(+), 11 deletions(-) rename docs/{ => system}/getting-help.md (93%) rename docs/{ => system}/getting-started.md (95%) diff --git a/docs/index.md b/docs/index.md index 0fe46f1..4b9e835 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,8 +16,8 @@ Information about the parts of the WROLPi interface. Information about a WROLPi system. -* [Getting Started](getting-started.md) -* [Getting Help](getting-help.md) +* [Getting Started](system/getting-started.md) +* [Getting Help](system/getting-help.md) * [Systems](system/index.md) * [Recommended Hardware](system/recommended-hardware.md) diff --git a/docs/getting-help.md b/docs/system/getting-help.md similarity index 93% rename from docs/getting-help.md rename to docs/system/getting-help.md index af3c25f..c2ae993 100644 --- a/docs/getting-help.md +++ b/docs/system/getting-help.md @@ -1,4 +1,5 @@ -# Getting Help Online +# Getting Help +## Online Help can be found online at these places: @@ -6,22 +7,22 @@ Help can be found online at these places: * WROLPi Github: [https://github.com/lrnselfreliance/wrolpi](https://github.com/lrnselfreliance/wrolpi) * WROLPi Youtube Channel: [https://www.youtube.com/@wrolpi](https://www.youtube.com/@wrolpi) -## `install.sh` +### `install.sh` WROLPi may be repaired using the installation script which requires internet, run it like so: `/opt/wrolpi/install.sh` -# Getting Help Offline +## Offline -## `repair.sh` +### `repair.sh` WROLPi has a repair script which will attempt to repair the WROLPi while offline. It copies configs, restarts services, etc. Run the repair script like so: `/opt/wrolpi/repair.sh` -## `help.sh` +### `help.sh` WROLPi has a help script which checks common failure points on a WROLPi system, run it like so: @@ -86,9 +87,9 @@ OK: Help service is running The output above will help an experienced developer narrow down the cause of an issue. -# Reset +## Reset -## Reset API Database +### Reset API Database The `wrolpi` database contains the tables and indexes which allow you to search or even browse your WROLPi. A script is provided which will delete and re-create this database. **Warning you will need to refresh your files!** Run it if the diff --git a/docs/getting-started.md b/docs/system/getting-started.md similarity index 95% rename from docs/getting-started.md rename to docs/system/getting-started.md index 0c7816a..50756e2 100644 --- a/docs/getting-started.md +++ b/docs/system/getting-started.md @@ -9,7 +9,7 @@ To finish your WROLPi installation follow these steps: 2. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh` 3. Reboot: `sudo reboot` 4. After reboot, browse to `http://wrolpi.local` or `http://127.0.0.1` on the WROLPi itself. -5. [Refresh your files](modules/files/index.md#refreshing) +5. [Refresh your files](../modules/files/index.md#refreshing) # Creating a new WROLPi @@ -57,4 +57,4 @@ on a new Debian computer. 6. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh` 7. Reboot: `sudo reboot` 8. Join the Hotspot or browse to `http://wrolpi.local` or the IP address of your WROLPi! -9. [Refresh your files](modules/files/index.md#refreshing) +9. [Refresh your files](../modules/files/index.md#refreshing)