More documentation

[dmitriim]

I found that setting up dataflows can be challenging. One of the reason for that is it requires you to know how a particular step actually works. You can try to guess, but you don't really want to.

Would be nice to improve documentation for this plugin in general and some bits in UI.

For example:

• add a help text to step config form elements. This should be detailed description.
• steps may have documentation on the wiki describing at least one case they are created for (with example)
• we may document some common use cases that we have used this plugin for
• we may document some crazy use cases we have used this plugin for

An extra point would be to improve API documentation and for base classes explain how each of the method is being used. E.g. instead of "Get the step reference" for get_ref method provide a detailed description what it's used for and what the reference is and etc.

The main goal here to make it all very predictable or as predictable as possible. Personally I have set up few workflows, but every time I had to look into the code and run it through x debug to understand what I need to do to achieve what I needed.

[dmitriim]

Example of the step required documentation/examples: switch step

After reading this description I'm still not 100% sure how I configure it. A little example would help a lot here.