From 5073f19ee3d25aabe6e38088f6d3c78f45ebee03 Mon Sep 17 00:00:00 2001 From: ukkopahis <95980324+ukkopahis@users.noreply.github.com> Date: Sat, 15 Jan 2022 04:15:22 +0200 Subject: [PATCH] docs: move developer documentation to subfolder * links fixed and changed to relative. Absolute links are not supported by mkdocs: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages --- .../{ => Developers}/BuildStack-RandomPassword.md | 0 docs/{ => Developers}/BuildStack-Services.md | 0 docs/{ => Developers}/Contributing-Services.md | 15 ++++++++------- docs/{ => Developers}/Menu-System.md | 0 docs/PostBuild-Script.md | 2 +- docs/index.md | 2 ++ 6 files changed, 11 insertions(+), 8 deletions(-) rename docs/{ => Developers}/BuildStack-RandomPassword.md (100%) rename docs/{ => Developers}/BuildStack-Services.md (100%) rename docs/{ => Developers}/Contributing-Services.md (73%) rename docs/{ => Developers}/Menu-System.md (100%) diff --git a/docs/BuildStack-RandomPassword.md b/docs/Developers/BuildStack-RandomPassword.md similarity index 100% rename from docs/BuildStack-RandomPassword.md rename to docs/Developers/BuildStack-RandomPassword.md diff --git a/docs/BuildStack-Services.md b/docs/Developers/BuildStack-Services.md similarity index 100% rename from docs/BuildStack-Services.md rename to docs/Developers/BuildStack-Services.md diff --git a/docs/Contributing-Services.md b/docs/Developers/Contributing-Services.md similarity index 73% rename from docs/Contributing-Services.md rename to docs/Developers/Contributing-Services.md index 4f8c4ec79..7fe80dc1e 100755 --- a/docs/Contributing-Services.md +++ b/docs/Developers/Contributing-Services.md @@ -9,8 +9,8 @@ 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](https://sensorsiot.github.io/IOTstack/Default-Configs) is updated with WUI port and username/password. -* Must detect port confilicts with other services on [BuildStack](https://sensorsiot.github.io/IOTstack/Menu-System) Menu. +* Ensure [Default Configs](../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. * Ensure that your service can be backed up and restored without errors or data loss. @@ -21,8 +21,9 @@ Services will grow over time, we may split up the buildstack menu into subsectio If your new service is approved and merged then congratulations! Please watch the Issues page on github over the next few days and weeks to see if any users have questions or issues with your new service. Links: -* [Default configs](https://sensorsiot.github.io/IOTstack/Default-Configs) -* [Password configuration for Services](https://sensorsiot.github.io/IOTstack/BuildStack-RandomPassword) -* [Build Stack Menu System](https://sensorsiot.github.io/IOTstack/Menu-System) -* [Coding a new service](https://sensorsiot.github.io/IOTstack/BuildStack-Services) -* [IOTstack issues](https://github.com/SensorsIot/IOTstack/issues) \ No newline at end of file + +* [Default configs](../Default-Configs.md) +* [Password configuration for Services](BuildStack-RandomPassword.md) +* [Build Stack Menu System](Menu-System.md) +* [Coding a new service](BuildStack-Services.md) +* [IOTstack issues](htps://github.com/SensorsIot/IOTstack/issues) diff --git a/docs/Menu-System.md b/docs/Developers/Menu-System.md similarity index 100% rename from docs/Menu-System.md rename to docs/Developers/Menu-System.md diff --git a/docs/PostBuild-Script.md b/docs/PostBuild-Script.md index 2bc8430e6..2cda0f3ca 100755 --- a/docs/PostBuild-Script.md +++ b/docs/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](https://sensorsiot.github.io/IOTstack/Menu-System) 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/index.md b/docs/index.md index 96f903005..f880d0fbc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,3 +9,5 @@ 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). + +* To contribute see [Contributing Services](Developers/Contributing-Services.md)