add more docs

Author: melezhik

Changes

@@ -2,13 +2,13 @@ Revision history for Sparky
 
 {{$NEXT}}
 
-0.2.7 2024-06-13T23:57:00Z
+0.2.7 2024-06-14T11:59:00Z
 
   - Huge overhaul of documentation
   - UI - subtasks
   - UI - multiple select 
   - Artifacts (not yet documented)
-  
+
 0.2.6 2024-05-31T11:20:00Z
 
   - Spruce up CSS

README.md

@@ -193,14 +193,13 @@ Sparky uses [Sparrowdo](https://github.com/melezhik/sparrowdo) to launch jobs in
 \--------------------/                                             [ ssh host  ]
 ```
 
-By default job scenarios get executed _on the same machine you run Sparky at_, but you can change this to _any remote host_ setting Sparrowdo section in `sparky.yaml` file:
+By default job scenarios get executed _on the same machine you run Sparky at_, 
+to run jobs on _remote host_ set sparrowdo section in `sparky.yaml` file:
 
 ```bash
 $ nano ~/.sparky/projects/teddy-bear-app/sparky.yaml
 ```
 
-And define worker configuration:
-
 ```yaml
 sparrowdo:
   host: '192.168.0.1'
@@ -214,7 +213,8 @@ Follow [sparrowdo cli](https://github.com/melezhik/sparrowdo#sparrowdo-cli) docu
 
 ### Skip bootstrap
 
-Sparrowdo bootstrap takes a while, if you don't need bootstrap ( sparrow client is already installed at a target host ) use `bootstrap: false` option:
+Sparrowdo clinent bootstrap might take some time, disable bootstrap by 
+( if client is already installed on target host ) using `bootstrap: false` option:
 
 ```yaml
 sparrowdo:
@@ -416,43 +416,25 @@ tls:
 
 `SPARKY_USE_TLS` enables SSL mode and `tls` section has paths to ssl certificate ( key and certificate parts ).
 
-# Command line client
-
-To trigger Sparky job in terminal use `sparky-runner.raku` cli:
-
-```bash
-$ sparky-runner.raku --dir=/home/user/.sparky/projects/teddy-bear-app
-```
-
-Or just:
-
-```bash
-$ cd ~/.sparky/projects/teddy-bear-app && sparky-runner.raku
-```
-
-## Sparky runtime parameters
+# Additional topics
 
-Runtime parameters could be overridden by command line ( `--root`, `--work-root` )
+## Sparky cli
 
-###  Root directory
+Sparky cli allows to trigger jobs in terminal.
 
-This is Sparky root directory, or directory where Sparky looks for jobs descriptions:
+Read more at [docs/cli.md](https://github.com/melezhik/sparky/blob/master/docs/cli.md)
 
-```bash
-~/.sparky/projects/
-```
+## Sparky Environment variables
 
-###  Work directory
+Use environment variables to tune Sparky configuration.
 
-This is working directory where sparky might place some stuff, useless at the moment:
+Read more at [docs/env.md](https://github.com/melezhik/sparky/blob/master/docs/env.md)
 
-```bash
-~/.sparky/work
-```
+# Glossary
 
-# Sparky Environment variables
+Some useful glossary.
 
-Read more at [docs/env.md](https://github.com/melezhik/sparky/blob/master/docs/env.md)
+Read more at [docs/glossary.md](https://github.com/melezhik/sparky/blob/master/docs/glossary.md)
 
 # CSS
 

docs/cli.md

@@ -0,0 +1,37 @@
+# Cli
+
+Command line client for Sparky
+
+## Trigger jobs
+
+To trigger Sparky job in terminal use `sparky-runner.raku` cli:
+
+```bash
+$ sparky-runner.raku --dir=/home/user/.sparky/projects/teddy-bear-app
+```
+
+Or just:
+
+```bash
+$ cd ~/.sparky/projects/teddy-bear-app && sparky-runner.raku
+```
+
+## Sparky runtime parameters
+
+Runtime parameters could be overridden by command line ( `--root`, `--work-root` )
+
+### root directory
+
+Directory where scheduller looks for job scenarios, by default:
+
+```bash
+~/.sparky/projects/
+```
+
+###  work directory
+
+Directory where scheduller keeps internal jobs data:
+
+```bash
+~/.sparky/work
+```

docs/glossary.md

@@ -0,0 +1,58 @@
+# Glossary
+
+Some useful glossary
+
+# Job aka Sparky aka Sparky project
+
+Raku scenario gets executed on some event and does some useful job
+
+# Sparky scenario
+
+Implimentation of Sparky job written on Raku
+
+# Build
+
+A specific instance of Sparky job. Usually reports are visibale though UI and
+might have some artifacts
+
+# Report
+
+Log of Sparky job exececution
+
+# Artifact
+
+Some byproducts ( technucally are files) attached to a build and visible through UI
+
+# UI aka Sparky web UI
+
+Web application to run Sparky jobs and get their reports
+
+# Sparrowdo
+
+A client to run Sparky jobs on (remote) hosts and docker containers
+
+# Sparrow
+
+Underlying automation framework to execute Sparky job
+
+# sparky.yaml
+
+YAML defintion of Sparky job meta information, like input patrameters, UI controls,
+triggering logic, etc. Every Sparky job has a sparky.yaml file
+
+
+# root directory
+
+Directory where scheduller looks for job scenarios, by default:
+
+```bash
+~/.sparky/projects/
+```
+
+#  work directory
+
+Directory where scheduller keeps internal jobs data:
+
+```bash
+~/.sparky/work
+```