Adding instructions for adding a software title to the armbian-config

docs/User-Guide_Armbian-Software.md

@@ -1,11 +1,174 @@
+# Armbian Software
+
 !!! warning teweew
 
     Following instructions are valid for next generation of Armbian config utility which is due for integration in **Armbian v24.11**. Until then please follow this installation instructions to test it out:
     <https://github.com/armbian/configng?tab=readme-ov-file#add--install-from-development-repository>
 
-# Armbian Software
-
 To start the Armbian software section, use the following command:
 ~~~
 sudo armbian-config
-~~~
+~~~
+
+## Adding example
+
+### Tinkering
+
+#### Manual install
+
+First try to install application manually. If it works on Debian or Ubuntu, proceed. In this example we will be using `Portainer`, which simplifies your Docker container management via web interface.
+
+#### Clone repository
+
+~~~
+git clone https://github.com/armbian/configng
+~~~
+
+#### Design menu
+
+Predict which commands you expect to have in the menu. For installing an application, we usually need two, `install` and `uninstall`. Armbian-config stores menu in JSON files, so you need to select appropriate file.
+This one we will place under `Software -> Containers`.
+
+``` yaml title="File location: tools/json/config.software.json"
+{
+    "id": "SP27",
+    "description": "Install Portainer",
+    "prompt": "This operation will install Portainer.\nWould you like to continue?",
+    "command": ["module_portainer install"],
+    "status": "Stable",
+    "author": "@armbian",
+    "condition": "! module_portainer status"
+},
+{
+    "id": "SP28",
+    "description": "Remove Portainer",
+    "prompt": "This operation will delete Portainer container.\nWould you like to continue?",
+    "command": ["module_portainer uninstall"],
+    "status": "Stable",
+    "author": "@armbian",
+    "condition": "module_portainer status"
+}
+```
+
+| Field name | Function | Notes |
+| :---------------------- | :-------------- | :----------- |
+| `id` |  `unique identifier` | Select higher number. If you will select existing, application will fail to run |
+| `description` |  `menu descriptor` | This will be displayed in the menu |
+| `prompt` |  `confirmation text` | Some features needs confirmation before proceeding |
+| `command` |  `executes function` | What should be run after we select and agree (optional) |
+| `status` |  `Stable|Disabled` | Control if function is shown to users in the menu |
+| `author` |  `GitHub handle` | Developer or maintainer of this functionality |
+| `condition` |  `controlling display` | Under what conditions we show this menu item |
+
+
+!!! note
+
+    Pay attention to JSON structure. JSON validator at pull request will break in case spaces or commas will be placed wrong.
+
+#### Module code
+
+``` bash title="File location: lib/armbian-configng/config.ng.software.sh"
+module_options+=(
+	["update_skel,author"]="@armbian"
+	["update_skel,ref_link"]=""
+	["update_skel,feature"]="module_portainer"
+	["update_skel,desc"]="Install/uninstall/check status of portainer container"
+	["update_skel,example"]="module_portainer install|uninstall|status"
+	["update_skel,status"]="Active"
+)
+#
+# Install portainer container
+#
+module_portainer() {
+
+	if check_if_installed docker-ce; then
+		local container=$(docker container ls -a | mawk '/portainer\/portainer(-ce)?( |$)/{print $1}')
+		local image=$(docker image ls -a | mawk '/portainer\/portainer(-ce)?( |$)/{print $3}')
+	fi
+
+	case "$1" in
+		install)
+			check_if_installed docker-ce || install_docker
+			docker volume ls -q | grep -xq 'portainer_data' || docker volume create portainer_data
+			docker run -d -p '9002:9000' --name=portainer --restart=always \
+			-v '/run/docker.sock:/var/run/docker.sock' \
+			-v '/etc/ssl/certs/ca-certificates.crt:/etc/ssl/certs/ca-certificates.crt:ro' \
+			-v 'portainer_data:/data' 'portainer/portainer-ce'
+		;;
+		uninstall)
+			[[ "${container}" ]] && docker container rm -f "$container"
+			[[ "${image}" ]] && docker image rm "$image"
+		;;
+		status)
+			[[ "${container}" ]] || [[ "${image}" ]] && return 0
+		;;
+	esac
+
+}
+```
+
+!!! note
+
+    Pay attention to [coding style structure](https://github.com/armbian/configng/blob/main/.editorconfig). If you use modern IDE, this will be done automatically. 
+
+#### Manual testing
+
+Whenever you are making changes to the JSON structure, make sure to join JSON segments into main JSON file. This you do with a command:
+``` python
+tools/config-jobs -j lib/armbian-configng/config.ng.jobs.json
+```
+Python is required to run this tool.
+
+``` bash
+sudo sudo bin/armbian-config --cmd
+```
+
+#### Unit tests
+
+This part is optional but highly recommended for at least install functionality. Our CI infrastructure will test this feature at pull request, on general code changes (push to main branch) and daily. It will test feature on latest Debian and Ubuntu images.
+Unit tests have simple design:
+
+Name of the config file is function id (unique identifier) `SP27.conf`
+
+``` bash title="File location: tests/SP27.conf"
+ENABLED=true
+RELEASE="bookworm:jammy:noble"
+CONDITION="test=\$(docker container ls -a |  grep portainer )"
+```
+Make sure to add a test condition that makes sense. It has to return 0 when test succeeds and 1 if fails.
+
+| Variable | Function | Description |
+| :---------------------- | :-------------- | :-------------- |
+| ENABLED | false / true | If test is live or not |
+| PREINSTALL | cmd to run | specific test dependencies |
+| CONDITION | main test verification | must return 0 for test success |
+| RELEASE  | bookworm:jammy:noble" | run on specific or leave empty to run on all |
+
+#### Pull request
+
+When your solution works locally and you prepare unit tests its time to submit a pull request. Fix your code and unit tests until all pull request checks becomes green.
+
+### Documentation
+
+Documentation is generated automatically after your pull request is merged. But as automated documentation might not be satisfactory, you can add cover image, header and footer. You can use markdown elements with enhancements from https://squidfunk.github.io/mkdocs-material/
+
+#### Cover image
+
+Once code works perfectly, look for cover image. It can be .png or .webp. Place image to the `tools/include/images/SP27.webp`
+
+#### Header
+
+``` text title="Header: tools/include/markdown/SP27-header.md"
+Portainer simplifies your Docker container management via Portainer web interface. It enables faster deploy of the applications and it gives real time visibility.
+```
+
+#### Footer
+
+``` text title="Footer: tools/include/markdown/SP27-footer.md"
+
+=== "Access to the web interface"
+
+    The web interface is accessible via port **9002**:
+
+    - URL = `http://<your.IP>:9002`
+```

mkdocs.yml

@@ -68,6 +68,11 @@ markdown_extensions:
       auto_title: true
       linenums: true
       use_pygments: true
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
   - pymdownx.superfences:
       custom_fences:
       - name: mermaid