From 5f8094468e9259117429965f51f2742898186c10 Mon Sep 17 00:00:00 2001 From: Axel Hahn <ax2002@gmx.net> Date: Thu, 13 Mar 2025 00:44:36 +0100 Subject: [PATCH] update docs --- docs/10_Introduction.md | 1 + docs/30_Usage.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/10_Introduction.md b/docs/10_Introduction.md index 1d2a4d7..02063a1 100644 --- a/docs/10_Introduction.md +++ b/docs/10_Introduction.md @@ -3,6 +3,7 @@ ### Why? What? The IML appmonitor has a client and a server written in PHP. +👉 See 🌐 <https://github.com/iml-it/appmonitor> All our web projects running with PHP were simple to integrate. But what about all the projects running on NodeJs, Ruby, Python, Java? The can run their checks and need to create a JSON response in the required syntax. diff --git a/docs/30_Usage.md b/docs/30_Usage.md index 374d698..dff2097 100644 --- a/docs/30_Usage.md +++ b/docs/30_Usage.md @@ -92,7 +92,7 @@ params[message]="Here is ${USER}" ### Types of values -The binary uses the php function `parse_ini_file` - see <https://www.php.net/manual/en/function.parse-ini-file.php>. +The binary uses the php function `parse_ini_file` - see 🌐 <https://www.php.net/manual/en/function.parse-ini-file.php>. * The **section** is in brackets eg. `[<SECTION>]` * In each section is a set of keys and values, separated by `=` @@ -109,9 +109,9 @@ The binary uses the php function `parse_ini_file` - see <https://www.php.net/man * Specialty: In [check] -> params you can use JSON syntax: It is aquoted string using single quotes `'`. The JSON key and value must be quoted with double quotes. * Environment variables or PHP configuration values can be embedded using `${<VARMAME>}`; it works with unquoted value or double quoted strings but not inside single quotes (or JSON). -The values for each check are check specific. Have a look to the origin docs for each check - see <https://os-docs.iml.unibe.ch/appmonitor/PHP_client/Plugins/Checks/index.html>. +The values for each check are check specific. Have a look to the origin docs for each check - see 📗 <https://os-docs.iml.unibe.ch/appmonitor/PHP_client/Plugins/Checks/index.html>. -To have a minimal working example have a the folder `tests/configs` or here <https://git-repo.iml.unibe.ch/iml-open-source/appmonitor-cli-client/-/tree/main/tests/configs?>. These ini files do NOT contain all supported keys. +To have a minimal working example have a the folder `tests/configs` or here 🌐 <https://git-repo.iml.unibe.ch/iml-open-source/appmonitor-cli-client/-/tree/main/tests/configs?>. These ini files do NOT contain all supported keys. ## Exitcodes -- GitLab