docs: Add top navigation tabs

* Add top tabs: Basic setup, Containers, Developers * these were chosen in order to be in a sensible alphabetical order * files moved to corresponding folders and links updated * Add redirect from old file locations * "Basic setup" has a lot of items. Update related pages organized into the "Updates" subtopic, to make it a bit more clear.
SensorsIot · Jan 28, 2022 · 6be71a5 · 6be71a5
1 parent 1eacd40
commit 6be71a5
Show file tree

Hide file tree

Showing 21 changed files with 43 additions and 16 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,5 +14,6 @@ jobs:
         with:
           python-version: 3.x
       - run: pip install mkdocs-material
+      - run: pip install mkdocs-redirects
       - run: pip install mkdocs-git-revision-date-localized-plugin
       - run: mkdocs gh-deploy --force
diff --git a/...ccessing-your-Device-from-the-internet.md → ...ccessing-your-Device-from-the-internet.md b/...ccessing-your-Device-from-the-internet.md → ...ccessing-your-Device-from-the-internet.md
@@ -152,7 +152,7 @@ $ cat /dev/null >~/Logs/duck.log
 
 ### WireGuard
 
-WireGuard is supplied as part of IOTstack. See [WireGuard documentation](Containers/WireGuard.md).
+WireGuard is supplied as part of IOTstack. See [WireGuard documentation](../Containers/WireGuard.md).
 
 ### PiVPN
 

diff --git a/docs/Backup-and-Restore.md → docs/Basic_setup/Backup-and-Restore.md b/docs/Backup-and-Restore.md → docs/Basic_setup/Backup-and-Restore.md
diff --git a/docs/Custom.md → docs/Basic_setup/Custom.md b/docs/Custom.md → docs/Basic_setup/Custom.md
@@ -125,7 +125,7 @@ services:
     environment:
 ```
 
-This will remove the default environment variables set in the template, and tell docker-compose to use the variables specified in your file. It is not mandatory that the *.env file be placed in the service's service directory, but is strongly suggested. Keep in mind the [PostBuild Script](PostBuild-Script.md) functionality to automatically copy your *.env files into their directories on successful build if you need to.
+This will remove the default environment variables set in the template, and tell docker-compose to use the variables specified in your file. It is not mandatory that the *.env file be placed in the service's service directory, but is strongly suggested. Keep in mind the [PostBuild Script](../Developers/PostBuild-Script.md) functionality to automatically copy your *.env files into their directories on successful build if you need to.
 
 ### Adding custom services
 

diff --git a/docs/Default-Configs.md → docs/Basic_setup/Default-Configs.md b/docs/Default-Configs.md → docs/Basic_setup/Default-Configs.md
@@ -1,4 +1,4 @@
-# Build Stack Default Passwords for Services
+# Default Passwords and ports
 
 Here you can find a list of the default configurations for IOTstack for quick referece.
 

diff --git a/docs/Docker-commands.md → docs/Basic_setup/Docker-commands.md b/docs/Docker-commands.md → docs/Basic_setup/Docker-commands.md
diff --git a/docs/How-the-script-works.md → docs/Basic_setup/How-the-script-works.md b/docs/How-the-script-works.md → docs/Basic_setup/How-the-script-works.md
diff --git a/docs/Misc.md → docs/Basic_setup/Misc.md b/docs/Misc.md → docs/Basic_setup/Misc.md
diff --git a/docs/Native-RTL_433.md → docs/Basic_setup/Native-RTL_433.md b/docs/Native-RTL_433.md → docs/Basic_setup/Native-RTL_433.md
diff --git a/docs/Networking.md → docs/Basic_setup/Networking.md b/docs/Networking.md → docs/Basic_setup/Networking.md
diff --git a/docs/RPIEasy_native.md → docs/Basic_setup/RPIEasy_native.md b/docs/RPIEasy_native.md → docs/Basic_setup/RPIEasy_native.md
diff --git a/docs/Understanding-Containers.md → docs/Basic_setup/Understanding-Containers.md b/docs/Understanding-Containers.md → docs/Basic_setup/Understanding-Containers.md
diff --git a/docs/New-Menu-Release-Notes.md → ...c_setup/Updates/New-Menu-Release-Notes.md b/docs/New-Menu-Release-Notes.md → ...c_setup/Updates/New-Menu-Release-Notes.md
@@ -8,7 +8,8 @@ There are many features that are needing to be introduced into the new menu syst
 
 ## Breaking changes
 There are a few changes that you need to be aware of:
-* Docker Environmental `*.env` files are no longer a thing by default. Everything needed is specified in the service.yml file, you can still optionally use them though either with [Custom Overrides](Custom.md) or with the [PostBuild](PostBuild-Script.md) script. Specific config files for certain services still work as they once did.
+
+* Docker Environmental `*.env` files are no longer a thing by default. Everything needed is specified in the service.yml file, you can still optionally use them though either with [Custom Overrides](../Custom.md) or with the [PostBuild](../../Developers/PostBuild-Script.md) script. Specific config files for certain services still work as they once did.
 * Python 3, pip3, PyYAML and Blessed are all required to be installed.
 * Not backwards compatible with old menu system. You will be able to switch back to the old menu system for a period of time by changing to the `old-menu` branch. It will be unmaintained except for critical updates. It will eventually be removed - but not before everyone is ready to leave it.
 

diff --git a/docs/Updating-the-Project.md → ...sic_setup/Updates/Updating-the-Project.md b/docs/Updating-the-Project.md → ...sic_setup/Updates/Updating-the-Project.md
diff --git a/docs/gcgarner-migration.md → ...Basic_setup/Updates/gcgarner-migration.md b/docs/gcgarner-migration.md → ...Basic_setup/Updates/gcgarner-migration.md
diff --git a/docs/Getting-Started.md → docs/Basic_setup/index.md b/docs/Getting-Started.md → docs/Basic_setup/index.md
@@ -132,7 +132,7 @@ If you prefer to automate your installations using scripts, see:
 
 If you are still running on gcgarner/IOTstack and need to migrate to SensorsIot/IOTstack, see:
 
-* [Migrating IOTstack from gcgarner to SensorsIot](./gcgarner-migration.md).
+* [Migrating IOTstack from gcgarner to SensorsIot](Updates/gcgarner-migration.md).
 
 ## <a name="recommendedPatches"> recommended system patches </a>
 

diff --git a/docs/Containers/WireGuard.md b/docs/Containers/WireGuard.md
@@ -29,7 +29,7 @@ $ sudo apt upgrade -y
 Before you can use WireGuard (or any VPN solution), you need a mechanism for your remote clients to reach your home router. You have two choices:
 
 1. Obtain a permanent IP address for your home router from your Internet Service Provider (ISP). Approach your ISP if you wish to pursue this option. It generally involves additional charges.
-2. Use a Dynamic DNS service. See IOTstack documentation [Accessing your device from the internet](../Accessing-your-Device-from-the-internet.md). The rest of this documentation assumes you have chosen this option.
+2. Use a Dynamic DNS service. See IOTstack documentation [Accessing your device from the internet](../Basic_setup/Accessing-your-Device-from-the-internet.md). The rest of this documentation assumes you have chosen this option.
 
 ### <a name="serviceDefinition"> Step 3: Understand the Service Definition </a>
 
@@ -226,7 +226,7 @@ Of the two, the first is generally the simpler and means you don't have to re-ru
 
 #### <a name="editOverride"> Method 2: Configure WireGuard using `compose-override.yml` </a>
 
-The [Custom services and overriding default settings for IOTstack](../Custom.md) page describes how to use an override file to allow the menu to incorporate your custom configurations into the final `docker-compose.yml` file.
+The [Custom services and overriding default settings for IOTstack](../Basic_setup/Custom.md) page describes how to use an override file to allow the menu to incorporate your custom configurations into the final `docker-compose.yml` file.
 
 You will need to create the `compose-override.yml` **before** running the menu to build your stack. If you have already built your stack, you'll have to rebuild it after creating `compose-override.yml`.
 

diff --git a/docs/PostBuild-Script.md → docs/Developers/PostBuild-Script.md b/docs/PostBuild-Script.md → docs/Developers/PostBuild-Script.md
@@ -2,7 +2,7 @@
 The postbuild bash script allows for executing arbitrary execution of bash commands after the stack has been build.
 
 ## How to use
-Place a file in the main directory called `postbuild.sh`. When the buildstack [build logic](Developers/Menu-System.md) finishes, it'll execute the `postbuild.sh` script, passing in each service selected from the buildstack menu as a parameter. This script is run each time the buildstack logic runs.
+Place a file in the main directory called `postbuild.sh`. When the buildstack [build logic](../Developers/Menu-System.md) finishes, it'll execute the `postbuild.sh` script, passing in each service selected from the buildstack menu as a parameter. This script is run each time the buildstack logic runs.
 
 ## Updates
 The `postbuild.sh` file has been added to gitignore, so it won't be updated by IOTstack when IOTstack is updated. It has also been added to the backup script so that it will be backed up with your personal IOTstack backups.

diff --git a/docs/Developers/Contributing.md → docs/Developers/index.md b/docs/Developers/Contributing.md → docs/Developers/index.md
@@ -27,7 +27,7 @@ Services will grow over time, we may split up the buildstack menu into subsectio
 * `build.py` file is correct
 * Service allows for changing external WUI port from Build Stack's options menu if service uses a HTTP/S port
 * Use a default password, or allow the user to generate a random password for the service for initial installation. If the service asks to setup an account this can be ignored.
-* Ensure [Default Configs](../Default-Configs.md) is updated with WUI port and username/password.
+* Ensure [Default Configs](../Basic_setup/Default-Configs.md) is updated with WUI port and username/password.
 * Must detect port confilicts with other services on [BuildStack](Menu-System.md) Menu.
 * `Pre` and `Post` hooks work with no errors. 
 * Does not require user to edit config files in order to get the service running.
@@ -40,7 +40,7 @@ If your new service is approved and merged then congratulations! Please watch th
 
 Links:
 
-* [Default configs](../Default-Configs.md)
+* [Default configs](../Basic_setup/Default-Configs.md)
 * [Password configuration for Services](BuildStack-RandomPassword.md)
 * [Build Stack Menu System](Menu-System.md)
 * [Coding a new service](BuildStack-Services.md)

diff --git a/docs/index.md b/docs/index.md
@@ -8,6 +8,6 @@ Welcome to the IOTstack Wiki:
 
 * If you are looking for information on a specific container, click on the "Containers" folder at the bottom of the list.
 
-* If you are just getting started with IOTstack, see [Getting Started](./Getting-Started.md).
+* If you are just getting started with IOTstack, see [Getting Started](Basic_setup/).
 
-* To contribute see [Contributing](Developers/Contributing.md)
+* To contribute see [Contributing](Developers/)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,10 +20,35 @@ theme:
         name: Switch to light mode
   features:
     - tabs
-    - navigation.expand
-  plugins:
-    - search
-    - git-revision-date-localized
+    - navigation.tabs
+    - navigation.sections
+
+plugins:
+  - search
+  - redirects:
+      # Forward renamed pages to avoid breaking old links.
+      redirect_maps:
+        Getting-Started.md: Basic_setup/index.md
+        Accessing-your-Device-from-the-internet.md: Basic_setup/Accessing-your-Device-from-the-internet.md
+        Backup-and-Restore.md: Basic_setup/Backup-and-Restore.md
+        Custom.md: Basic_setup/Custom.md
+        Default-Configs.md: Basic_setup/Default-Configs.md
+        Docker-commands.md: Basic_setup/Docker-commands.md
+        How-the-script-works.md: Basic_setup/How-the-script-works.md
+        Misc.md: Basic_setup/Misc.md
+        Native-RTL_433.md: Basic_setup/Native-RTL_433.md
+        Networking.md: Basic_setup/Networking.md
+        RPIEasy_native.md: Basic_setup/RPIEasy_native.md
+        Understanding-Containers.md: Basic_setup/Understanding-Containers.md
+        Updates/New-Menu-Release-Notes.md: Basic_setup/Updates/New-Menu-Release-Notes.md
+        Updates/Updating-the-Project.md: Basic_setup/Updates/Updating-the-Project.md
+        Updates/gcgarner-migration.md: Basic_setup/Updates/gcgarner-migration.md
+        PostBuild-Script.md: Developers/PostBuild-Script.md
+        BuildStack-RandomPassword.md: Developers/BuildStack-RandomPassword.md
+        BuildStack-Services.md: Developers/BuildStack-Services.md
+        Menu-System.md: Developers/Menu-System.md
+        Contributing-Services.md: Developers/index.md
+
 markdown_extensions:
   - admonition
   - pymdownx.superfences