Hi all,

here is a new thread to discuss the adapter documentation.
Here is a link to the previous discussion in the release thread [1].

@Dominik I know that the registration is different, but since all adapters 
already have the three files (documentation.md, icon.png, and string.en), 
shouldn’t it be possible to also display the description in the UI.
How are we doing currently for the icons? Because they are loaded dynamically 
as well. I think the main difference is that the icons are loaded directly from 
the worker container and not from the backend. Couldn’t we do it similarly for 
the documentation file? (Please correct me if I am wrong)

Regarding the description on the Website. I think it would be great if we could 
generate this based on the markdown files for each adapter.

The documentation.md files mostly describe the configuration parameters of 
adapters and processors. I think it would be great to have additional examples 
how to use them. (e.g. describe how a CSV file is uploaded or how a PLC is 
connected). Should we include such examples into the documentation.md file or 
should there be another location for this? Any thoughts on that?

@Florian you wrote that you would like to work on the documentation. If you 
need anything to start with, please let us know.

Cheers,
Philipp



[1] https://lists.apache.org/thread/29w586db1btqo0ps1rgo3fscvt3tvrzg

Reply via email to