GitHub user tenthe added a comment to the discussion: Documentation Develop 
Processors

Cool, thanks for starting to collect all the options.
Did you also take a look at the "SKD" sections of the documentation? [1]
There are already some short descriptions there. Maybe we can expand them there.

We should discuss, where we want to have what kind of information. 
I like that you made a very detailed overview of all possibilities so that we 
can see how the current model looks like.
But I guess for users this will be overvelming and for us it will be hard to 
maintain when things change.

My suggestion would be to include this information in the Javadoc. In the SDK 
module [2] there is already a lot of JavaDoc, maybe we can check what is 
missing there and extend it.
All other information should be included in the documentation. There, I would 
especially like to have much more detailed descriptions of the concepts, as you 
have already started.

What do you think?

[1] https://streampipes.apache.org/docs/docs/extend-sdk-functions.html
[2] https://github.com/apache/streampipes/tree/dev/streampipes-sdk

GitHub link: 
https://github.com/apache/streampipes/discussions/1183#discussioncomment-4826574

----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]

Reply via email to