Skip to content

Commit 3a3b100

Browse files
committed
docs: fix unsupported absolute links
* Only relative links withing pages are supported: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages As an additional benefit, when running: $ mkdocs serve it will issues a warnings for invalid relative links
1 parent 97a8861 commit 3a3b100

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/Accessing-your-Device-from-the-internet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ $ cat /dev/null >~/Logs/duck.log
152152

153153
### WireGuard
154154

155-
WireGuard is supplied as part of IOTstack. See [WireGuard documentation](https://sensorsiot.github.io/IOTstack/Containers/WireGuard.html).
155+
WireGuard is supplied as part of IOTstack. See [WireGuard documentation](Containers/WireGuard.md).
156156

157157
### PiVPN
158158

docs/Containers/NextCloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ Nextcloud traffic is not encrypted. Do **not** expose it to the web by opening a
265265

266266
A script , or "agent", to assess the health of the MariaDB container has been added to the *local image* via the *Dockerfile*. In other words, the script is specific to IOTstack.
267267

268-
Because it is an instance of MariaDB, Nextcloud_DB inherits the health-check agent. See the [IOTstack MariaDB](https://sensorsiot.github.io/IOTstack/Containers/MariaDB/) documentation for more information.
268+
Because it is an instance of MariaDB, Nextcloud_DB inherits the health-check agent. See the [IOTstack MariaDB](MariaDB.md) documentation for more information.
269269

270270
## <a name="updatingNextcloud"> Keeping Nextcloud up-to-date </a>
271271

docs/Containers/WireGuard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ $ sudo apt upgrade -y
2929
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:
3030

3131
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.
32-
2. Use a Dynamic DNS service. See IOTstack documentation [Accessing your device from the internet](https://sensorsiot.github.io/IOTstack/Accessing-your-Device-from-the-internet.html). The rest of this documentation assumes you have chosen this option.
32+
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.
3333

3434
### <a name="serviceDefinition"> Step 3: Understand the Service Definition </a>
3535

@@ -226,7 +226,7 @@ Of the two, the first is generally the simpler and means you don't have to re-ru
226226

227227
#### <a name="editOverride"> Method 2: Configure WireGuard using `compose-override.yml` </a>
228228

229-
The [Custom services and overriding default settings for IOTstack](https://sensorsiot.github.io/IOTstack/Custom/) page describes how to use an override file to allow the menu to incorporate your custom configurations into the final `docker-compose.yml` file.
229+
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.
230230

231231
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`.
232232

docs/Custom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ services:
125125
environment:
126126
```
127127

128-
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](https://sensorsiot.github.io/IOTstack/PostBuild-Script) functionality to automatically copy your *.env files into their directories on successful build if you need to.
128+
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.
129129

130130
### Adding custom services
131131

docs/Getting-Started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ Cannot create container for service [service name here]: unknown log opt 'max-fi
423423

424424
Logging limits were added to prevent Docker using up lots of RAM if log2ram is enabled, or SD cards being filled with log data and degraded from unnecessary IO. See [Docker Logging configurations](https://docs.docker.com/config/containers/logging/configure/)
425425

426-
You can also turn logging off or set it to use another option for any service by using the IOTstack `docker-compose-override.yml` file mentioned at [IOTstack/Custom](https://sensorsiot.github.io/IOTstack/Custom/).
426+
You can also turn logging off or set it to use another option for any service by using the IOTstack `docker-compose-override.yml` file mentioned at [IOTstack/Custom](Custom.md).
427427

428428
### <a name="upContainer"> starting an individual container </a>
429429

docs/New-Menu-Release-Notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are many features that are needing to be introduced into the new menu syst
88

99
## Breaking changes
1010
There are a few changes that you need to be aware of:
11-
* 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](https://sensorsiot.github.io/IOTstack/Custom) or with the [PostBuild](https://sensorsiot.github.io/IOTstack/PostBuild-Script) script. Specific config files for certain services still work as they once did.
11+
* 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.
1212
* Python 3, pip3, PyYAML and Blessed are all required to be installed.
1313
* 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.
1414

@@ -26,4 +26,4 @@ There are a few changes that you need to be aware of:
2626
* Removed env files
2727
* Backup and restoring more streamlined
2828
* Documentation updated for all services
29-
* No longer needs to be installed in the home directory `~`.
29+
* No longer needs to be installed in the home directory `~`.

0 commit comments

Comments
 (0)