marlof / ScORCH

DevOps Orchestration for Obrar deploy and Ansible playbooks
http://www.autoscorch.com
Apache License 2.0
5 stars 1 forks source link

Add a "Documentation" feature for Manual tasks #182

Closed marlof closed 10 months ago

marlof commented 1 year ago

Is your feature request related to a problem? Please describe. No

Describe the solution you'd like The Manual task summary is quite limited. When a Manual task is created, there should be a way to link to documentation so the Manual task can remain a short summary but more in depth instructions can be shown. Maybe the Plugins can have an additional documentation directory (bin, functions. etc, docs). If the Manual task shows a keyword, then the documentation can be written to the log file.

Current method:

Manual "If live server do is like x, but if its VMWare do like y, or if other hypervisor do it more like z"

Suggested idea:

case $type in
    live_server  ) Manual  "Documentation:x" ;;
    vmware )       Manual  "Documentation:y" ;; 

And the documentation keyword in Manual looks in the plugins/project/docs directory for a corresponding file

Describe alternatives you've considered NA

Additional context NA

marlof commented 10 months ago

Documentation as a function would better:

case $type in
   live_server ) Documentation live_task1 ;;
   vmware     ) Documentation vmware_task1 ;;
marlof commented 10 months ago

Investigating use of variables in the plugin as an option

marlof commented 10 months ago

Add a doc variable in the plugin (See SP_TEST)

doc_TEST="

My documentation "

Call the variable in the plugin

Task "ls" Documentation doc_TEST