Skip to content

Commit 6be71a5

Browse files
committed
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.
1 parent 1eacd40 commit 6be71a5

21 files changed

+43
-16
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ jobs:
1414
with:
1515
python-version: 3.x
1616
- run: pip install mkdocs-material
17+
- run: pip install mkdocs-redirects
1718
- run: pip install mkdocs-git-revision-date-localized-plugin
1819
- run: mkdocs gh-deploy --force

docs/Accessing-your-Device-from-the-internet.md renamed to docs/Basic_setup/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](Containers/WireGuard.md).
155+
WireGuard is supplied as part of IOTstack. See [WireGuard documentation](../Containers/WireGuard.md).
156156

157157
### PiVPN
158158

File renamed without changes.

docs/Custom.md renamed to docs/Basic_setup/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](PostBuild-Script.md) 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](../Developers/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/Default-Configs.md renamed to docs/Basic_setup/Default-Configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Build Stack Default Passwords for Services
1+
# Default Passwords and ports
22

33
Here you can find a list of the default configurations for IOTstack for quick referece.
44

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)