Hi, I also agree and using the same approach as we have for pipeline elements would be great. There's already an issue for that [1]. The biggest hurdle is that we currently use a different registration approach for pipeline elements and adapters:
Adapters automatically register on startup and the adapter description is stored in CouchDB. Pipeline Elements only provide their description and installation is triggered by the backend/core. Once a pipeline element is installed, along with the element description a zip file is transferred from the service to the core which includes all assets (documentation, icons/images and the translation files). These files are stored in the core and used by the UI to display the documentation. To bring the documentation to the website, we have a very quick-and-dirty feature in the maven plugin which runs through all extensions and prepares the documentation for the website. I think we can do this step-by-step - we can discuss details in a separate thread! Cheers Dominik [1] https://issues.apache.org/jira/browse/STREAMPIPES-164 -----Original Message----- From: Tim <[email protected]> Sent: Saturday, August 20, 2022 10:32 AM To: [email protected] Subject: Re: AW: AW: Release branch 0.70.0 Hi, I also agree that we lack proper documentation here. Based on Florian's description, I believe we have already implemented this in a similar way for our processing elements. For each processing element, we provide a documentation file (e.g. https://github.com/apache/incubator-streampipes/blob/fcceac83c9a082eb39f0fe9657c7d186b77e4727/streampipes-extensions/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.booloperator.counter/documentation.md), which is then accessible in the UI and can be viewed directly in the pipeline editor, for example. Furthermore, they are also included in our documentation, see https://streampipes.apache.org/docs/docs/pe/org.apache.streampipes.processors.transformation.jvm.booloperator.counter.html As far as I know, we also provide this kind of documentation file for adapters, but it is only used to render the tiles in the "connect" view. Would it be possible to extend the documentation in a similar way as for processing elements and display all the documentation via an additional icon? What do you think about this? Best Tim Am 19.08.2022 22:31 schrieb Philipp Zehnder: > Hi Florian, > > this is a great idea. > It would be awesome to have descriptions and examples for each of the > adapters. > I think that currently the only description can be found here [1] and > there is not much detailed information, it is more an overview of > existing adapters. > > I like to discuss this topic further. The biggest question probably is > how we collect those tutorials and descriptions. > My suggestion would be to provide a detailed description for all the > configuration parameters, like the one for pipeline elements and > present them to the user within the software. > Additionally, it would be cool to have step-by-step examples > explaining how users can configure and use the adapters. I recently > saw a tool that seems to make such step-by-step guides quite simple > [2]. There users can make a short screencast and the guide is > automatically generated. I have not used the tool yet and I am not > sure if it is the right one for the purpose, but maybe someone else > already has experience with such tools. Ideally, we can provide both > short videos and small step-by-step descriptions with some examples. > > I guess a big challenge is to find a way that is also manageable. > Especially for the future when things change in the software to keep > everything up to date. > > Any further thoughts on that? > > Cheers, > Philip > > > [1] > https://streampipes.apache.org/docs/docs/pe/org.apache.streampipes.con > nect.protocol.stream.kafka.html > [2] https://scribehow.com/ > > > Von: Florian Micklich <[email protected]> > Datum: Freitag, 19. August 2022 um 22:06 > An: [email protected] <[email protected]> > Betreff: Re: AW: Release branch 0.70.0 Hi all, perfekt. I was also > able to build and start everything.I will also tick off some bullets > on the checklist. > I am a still little bit overwhelmed of the wide range of adapters and > the questions in my head how to use them. Without this information I > am not able to test the processors in their full power. > Is there a documentation and description of each adapter somewhere?I > think a user perspective documentation with an example for each > adapter (maybe with a quick example source reference) would be great, > also for new people using StreamPipes for the first time. > I am willing to start or continue this documentation. Is there any > documentation and description of each adapter anywhere with examples?I > will probably start a new discussion if that is ok with everyone? > > > Florian > > Am Freitag, dem 19.08.2022 um 18:35 +0000 schrieb Tim: >> Hi all, >> I've successfully built the release branch locally on my machine and >> started Streampipes via the test docker compose.Besides some small, >> first tests I've created the pre release checklist to track our >> testing progress.You can find it here: >> https://cwiki.apache.org/confluence/display/STREAMPIPES/0.70.0-Pre-Re >> lease+Checklist >> >> BestTim >> Am 19.08.2022 07:21 schrieb Philipp Zehnder: >> > Hi Florian, >> > thanks a lot.It would be great if you could help to test the >> > release candidate.The description how to build and start can be >> > found in [1] under thesection “Perform technical release readiness >> > assessment” >> > Here is a link to the release branch: >> > https://github.com/apache/incubator-streampipes/tree/rel/0.70.0 >> > >> > Cheers,Philipp >> > [1] >> > https://cwiki.apache.org/confluence/display/STREAMPIPES/Pre-Release >> > -Steps >> > >> > Von: Florian Micklich <[email protected]>Datum: Donnerstag, 18. >> > August 2022 um 13:06An: [email protected] < >> > [email protected]>Betreff: Re: Release branch 0.70.0Hi >> > Philipp,is there anything to do that I could support for the >> > release?GreetingsFlorian Am Montag, dem 15.08.2022 um 20:55 +0000 >> > schrieb Philipp Zehnder: >> > > Hi Tim,thanks a lot for preparing the release branch.I checked it >> > > out, built everything and run the e2e smoke testslocally and >> > > everything worked.I’d suggest that we perform some moretests and >> > > then we can continue with the release process.Cheers,PhilippVon: >> > > Tim <[email protected]>Datum: Montag, 15. August 2022 um19:31An: >> > > Dev <[email protected]>Betreff: Release branch0.70.0Hi >> > > everyone,I've created the branch for our upcoming release: >> > > https://github.com/apache/incubator-streampipes/tree/rel/0.70.0 >> > > >> > > Please feel free to test it.If there are any bug fixes that need >> > > tobe included in the release, youcan add them directly to the >> > > releasebranch.If we don't have any major issues, I plan to >> > > proceed with therelease inthe next week or two.BestTim
