Skip to content

Commit

Permalink
docs: move developer documentation to subfolder
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
ukkopahis committed Jan 28, 2022
1 parent 9e97ee3 commit 2459ef9
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 8 deletions.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)

* [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)
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/PostBuild-Script.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 2459ef9

Please sign in to comment.